feat(lex-cli): support new Permission and PermissionSet types (#110)

Author: shuuji3

packages/lex-cli/src/generator/index.ts

@@ -1,12 +1,12 @@
 import { readFile } from 'node:fs/promises';
 import {
-  toNamespace,
   getDescriptions,
-  writeJsdoc,
   mainPrelude,
   sortDefinition,
   sortName,
   sortPropertyKeys,
+  toNamespace,
+  writeJsdoc,
 } from '../utils/index.js';
 import { resolveType } from './resolvers/index.js';
 import { type DocumentSchema, documentSchema } from './schema.js';
@@ -167,6 +167,10 @@ ${metadataLines.join('\n')}`;
 
         chunk += '}';
 
+        if (key === 'main') {
+          chunk += 'type Main = Record;';
+        }
+
         records += `\n'${nsid}': ${tsNamespace}.Record;`;
       } else if (type === 'query' || type === 'procedure') {
         let parameters = def.parameters;
@@ -264,6 +268,11 @@ ${metadataLines.join('\n')}`;
       } else if (type === 'bytes') {
         const { value, descriptions } = resolveType(nsid, def);
 
+        chunk += writeJsdoc(descriptions);
+        chunk += `type ${typeName} = ${value};`;
+      } else if (type === 'permission' || type === 'permission-set') {
+        const { value, descriptions } = resolveType(nsid, def);
+
         chunk += writeJsdoc(descriptions);
         chunk += `type ${typeName} = ${value};`;
       } else if (type === 'subscription') {

packages/lex-cli/src/generator/resolvers/primitives.ts

@@ -8,6 +8,10 @@ export function resolvePrimitiveType(type: string): string {
       return 'At.Bytes';
     case 'blob':
       return 'At.Blob';
+    case 'permission':
+      return 'At.Permission';
+    case 'permission-set':
+      return 'At.PermissionSet';
     default:
       return 'unknown';
   }

packages/lex-cli/src/generator/resolvers/type.ts

@@ -29,8 +29,11 @@ export function resolveType(
     case 'cid-link':
     case 'blob':
     case 'bytes':
+    case 'permission':
+    case 'permission-set':
       val = resolvePrimitiveType(def.type);
       break;
+
     case 'integer':
       val = resolveIntegerType(def, descs);
       break;

packages/lex-cli/src/generator/schema.ts

@@ -349,6 +349,30 @@ export const recordSchema = t.isObject({
 
 export type RecordSchema = t.InferType<typeof objectSchema>;
 
+export const permissionSchema = t.isObject({
+  type: t.isLiteral('permission'),
+  description: t.isOptional(t.isString()),
+  resource: t.isString(),
+  lxm: t.isOptional(t.isArray(t.isString())),
+  action: t.isOptional(t.isArray(t.isString())),
+  collection: t.isOptional(t.isArray(t.isString())),
+  inheritAud: t.isOptional(t.isBoolean()),
+});
+
+export type PermissionSchema = t.InferType<typeof permissionSchema>;
+
+export const permissionSetSchema = t.isObject({
+  type: t.isLiteral('permission-set'),
+  description: t.isOptional(t.isString()),
+  title: t.isOptional(t.isString()),
+  'title:lang': t.isOptional(t.isRecord(t.isUnknown())),
+  detail: t.isOptional(t.isString()),
+  'detail:lang': t.isOptional(t.isRecord(t.isUnknown())),
+  permissions: t.isArray(permissionSchema),
+});
+
+export type PermissionSetSchema = t.InferType<typeof permissionSetSchema>;
+
 export const userTypeSchema = t.isOneOf([
   recordSchema,
   xrpcQuerySchema,
@@ -364,6 +388,8 @@ export const userTypeSchema = t.isOneOf([
   bytesSchema,
   cidLinkSchema,
   unknownSchema,
+  permissionSchema,
+  permissionSetSchema,
 ]);
 
 export type UserTypeSchema = t.InferType<typeof userTypeSchema>;

packages/lex-cli/src/utils/formats.ts

@@ -12,5 +12,7 @@ export const IGNORED_FORMATS = new Set([
   'datetime',
   'language',
   'nsid',
+  'record-key',
+  'tid',
   'uri',
 ]);

packages/lex-cli/src/utils/prelude.ts

@@ -60,4 +60,20 @@ export declare namespace At {
     };
     size: number;
   }
+
+  /** Individual permission entry */
+  interface Permission {
+    resource: string;
+    lxm?: string[];
+    action?: string[];
+    collection?: string[];
+    inheritAud?: boolean;
+  }
+
+  /** Set of permissions */
+  interface PermissionSet {
+    title?: string;
+    detail?: string;
+    permissions: Permission[];
+  }
 }`;