@eide/foir-cli 0.1.16 → 0.1.18

package/dist/codegen/generators/typed-operations-common.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates the shared _common.ts file for typed operations.
+ * Contains generic wrapper types used by all per-model operation modules.
+ */
+export declare function generateTypedOperationsCommon(): string;
+//# sourceMappingURL=typed-operations-common.d.ts.map

package/dist/codegen/generators/typed-operations-common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-operations-common.d.ts","sourceRoot":"","sources":["../../../src/codegen/generators/typed-operations-common.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,wBAAgB,6BAA6B,IAAI,MAAM,CAqEtD"}

package/dist/codegen/generators/typed-operations-common.js

@@ -0,0 +1,74 @@
+/**
+ * Generates the shared _common.ts file for typed operations.
+ * Contains generic wrapper types used by all per-model operation modules.
+ */
+export function generateTypedOperationsCommon() {
+    return `/**
+ * Shared types for typed GraphQL operations.
+ *
+ * @generated by foir — DO NOT EDIT MANUALLY
+ */
+
+/** A record with strongly-typed data. */
+export interface BaseRecord<T> {
+  id: string;
+  modelKey: string;
+  naturalKey: string | null;
+  data: T;
+  metadata: Record<string, unknown> | null;
+  publishedVersionNumber: number | null;
+  publishedAt: string | null;
+  versionNumber: number | null;
+  changeDescription: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+/** Resolved content wrapping strongly-typed data. */
+export interface ResolvedContent<T> {
+  content: T;
+  record: { id: string; modelKey: string; naturalKey: string | null };
+  version: { id: string; versionNumber: number } | null;
+}
+
+/** Paginated list result. */
+export interface PaginatedResult<T> {
+  items: BaseRecord<T>[];
+  total: number;
+}
+
+/** Result of a createRecord mutation. */
+export interface CreateRecordResult<T> {
+  record: BaseRecord<T>;
+}
+
+/** Result of an updateRecord mutation. */
+export interface UpdateRecordResult<T> {
+  record: BaseRecord<T>;
+  matched: boolean;
+}
+
+/** Result of a deleteRecord mutation. */
+export interface DeleteRecordResult {
+  id: string;
+}
+
+/** Share resource type. */
+export interface ShareResult {
+  id: string;
+  resourceType: string;
+  permission: string;
+  status: string;
+  acceptedAt: string | null;
+  declinedAt: string | null;
+  expiresAt: string | null;
+  createdAt: string;
+  revokedAt: string | null;
+}
+
+/** A share that includes the shared record. */
+export interface ShareWithRecord<T> extends ShareResult {
+  record: BaseRecord<T>;
+}
+`;
+}

package/dist/codegen/generators/typed-operations-index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates the operations/index.ts barrel re-export file.
+ */
+import type { CodegenModel } from '../fetch-models.js';
+export declare function generateTypedOperationsIndex(models: CodegenModel[], hasCustomerProfile: boolean): string;
+//# sourceMappingURL=typed-operations-index.d.ts.map

package/dist/codegen/generators/typed-operations-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-operations-index.d.ts","sourceRoot":"","sources":["../../../src/codegen/generators/typed-operations-index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,YAAY,EAAE,EACtB,kBAAkB,EAAE,OAAO,GAC1B,MAAM,CAsBR"}

package/dist/codegen/generators/typed-operations-index.js

@@ -0,0 +1,22 @@
+/**
+ * Generates the operations/index.ts barrel re-export file.
+ */
+export function generateTypedOperationsIndex(models, hasCustomerProfile) {
+    const lines = [];
+    lines.push(`/**
+ * Typed GraphQL operations.
+ *
+ * @generated by foir — DO NOT EDIT MANUALLY
+ */
+
+export * from './_common.js';
+`);
+    for (const model of models) {
+        lines.push(`export * from './${model.key}.js';`);
+    }
+    if (hasCustomerProfile) {
+        lines.push(`export * from './customer-profile.js';`);
+    }
+    lines.push('');
+    return lines.join('\n');
+}

package/dist/codegen/generators/typed-operations.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generates per-model typed operation modules.
+ * Each module exports gql tagged templates + typed Variables/Result interfaces.
+ */
+import type { CodegenModel } from '../fetch-models.js';
+export declare function generateTypedOperations(model: CodegenModel, typesRelPath: string): string;
+/**
+ * Compute the relative import path from the operations dir to the types dir.
+ */
+export declare function computeTypesRelPath(opsDir: string, typesDir: string): string;
+//# sourceMappingURL=typed-operations.d.ts.map

package/dist/codegen/generators/typed-operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-operations.d.ts","sourceRoot":"","sources":["../../../src/codegen/generators/typed-operations.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGvD,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,YAAY,EACnB,YAAY,EAAE,MAAM,GACnB,MAAM,CA4QR;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,GACf,MAAM,CAGR"}

package/dist/codegen/generators/typed-operations.js

@@ -0,0 +1,251 @@
+/**
+ * Generates per-model typed operation modules.
+ * Each module exports gql tagged templates + typed Variables/Result interfaces.
+ */
+import path from 'path';
+import { toPascalCase, toUpperSnakeCase } from '../field-mapping.js';
+export function generateTypedOperations(model, typesRelPath) {
+    const typeName = toPascalCase(model.key);
+    const upperSnake = toUpperSnakeCase(model.key);
+    const pluralName = model.pluralName
+        ? toPascalCase(model.pluralName.replace(/\s+/g, ''))
+        : `${typeName}s`;
+    const pluralUpperSnake = model.pluralName
+        ? toUpperSnakeCase(model.pluralName.replace(/\s+/g, ''))
+        : `${upperSnake}S`;
+    const dataType = `${typeName}Data`;
+    const lines = [];
+    lines.push(`/**
+ * Typed operations for ${model.name ?? model.key}
+ *
+ * @generated by foir — DO NOT EDIT MANUALLY
+ */
+
+import type { ${dataType} } from '${typesRelPath}/models/${model.key}.js';
+import type {
+  BaseRecord,
+  ResolvedContent,
+  PaginatedResult,
+  CreateRecordResult,
+  UpdateRecordResult,
+  DeleteRecordResult,${model.config.sharing?.enabled ? '\n  ShareResult,\n  ShareWithRecord,' : ''}
+} from './_common.js';
+`);
+    // Type alias
+    lines.push(`export type ${typeName}Record = BaseRecord<${dataType}>;`);
+    lines.push('');
+    // GET query
+    lines.push(`export const GET_${upperSnake} = \`
+  query Get${typeName}($id: ID!, $locale: String, $preview: Boolean) {
+    record(id: $id) {
+      id modelKey naturalKey data metadata
+      publishedVersionNumber publishedAt versionNumber changeDescription
+      createdAt updatedAt
+      resolved(locale: $locale, preview: $preview) {
+        content
+        record { id modelKey naturalKey }
+        version { id versionNumber }
+      }
+    }
+  }
+\`;`);
+    lines.push('');
+    lines.push(`export interface Get${typeName}Variables {
+  id: string;
+  locale?: string;
+  preview?: boolean;
+}`);
+    lines.push('');
+    lines.push(`export interface Get${typeName}Result {
+  record: ${typeName}Record & {
+    resolved: ResolvedContent<${dataType}> | null;
+  } | null;
+}`);
+    lines.push('');
+    // GET BY KEY query
+    lines.push(`export const GET_${upperSnake}_BY_KEY = \`
+  query Get${typeName}ByKey($naturalKey: String!, $locale: String, $preview: Boolean) {
+    recordByKey(modelKey: "${model.key}", naturalKey: $naturalKey) {
+      id modelKey naturalKey data metadata
+      publishedVersionNumber publishedAt versionNumber changeDescription
+      createdAt updatedAt
+      resolved(locale: $locale, preview: $preview) {
+        content
+        record { id modelKey naturalKey }
+        version { id versionNumber }
+      }
+    }
+  }
+\`;`);
+    lines.push('');
+    lines.push(`export interface Get${typeName}ByKeyVariables {
+  naturalKey: string;
+  locale?: string;
+  preview?: boolean;
+}`);
+    lines.push('');
+    lines.push(`export interface Get${typeName}ByKeyResult {
+  recordByKey: ${typeName}Record & {
+    resolved: ResolvedContent<${dataType}> | null;
+  } | null;
+}`);
+    lines.push('');
+    // LIST query
+    lines.push(`export const LIST_${pluralUpperSnake} = \`
+  query List${pluralName}($limit: Int, $offset: Int, $filters: [FilterInput!], $sort: SortInput) {
+    records(modelKey: "${model.key}", limit: $limit, offset: $offset, filters: $filters, sort: $sort) {
+      items {
+        id modelKey naturalKey data metadata
+        publishedVersionNumber publishedAt versionNumber changeDescription
+        createdAt updatedAt
+      }
+      total
+    }
+  }
+\`;`);
+    lines.push('');
+    lines.push(`export interface List${pluralName}Variables {
+  limit?: number;
+  offset?: number;
+  filters?: Array<{ field: string; operator: string; value: unknown }>;
+  sort?: { field: string; direction: 'ASC' | 'DESC' };
+}`);
+    lines.push('');
+    lines.push(`export interface List${pluralName}Result {
+  records: PaginatedResult<${dataType}>;
+}`);
+    lines.push('');
+    // CREATE mutation
+    lines.push(`export const CREATE_${upperSnake} = \`
+  mutation Create${typeName}($input: CreateRecordInput!) {
+    createRecord(input: $input) {
+      record {
+        id modelKey naturalKey data metadata createdAt updatedAt
+      }
+    }
+  }
+\`;`);
+    lines.push('');
+    lines.push(`export interface Create${typeName}Variables {
+  input: {
+    modelKey: string;
+    naturalKey?: string;
+    data: Partial<${dataType}>;
+    metadata?: Record<string, unknown>;
+  };
+}`);
+    lines.push('');
+    lines.push(`export interface Create${typeName}Result {
+  createRecord: CreateRecordResult<${dataType}>;
+}`);
+    lines.push('');
+    // UPDATE mutation
+    lines.push(`export const UPDATE_${upperSnake} = \`
+  mutation Update${typeName}($input: UpdateRecordInput!) {
+    updateRecord(input: $input) {
+      record {
+        id modelKey naturalKey data metadata createdAt updatedAt
+      }
+      matched
+    }
+  }
+\`;`);
+    lines.push('');
+    lines.push(`export interface Update${typeName}Variables {
+  input: {
+    id: string;
+    data?: Partial<${dataType}>;
+    metadata?: Record<string, unknown>;
+    changeDescription?: string;
+  };
+}`);
+    lines.push('');
+    lines.push(`export interface Update${typeName}Result {
+  updateRecord: UpdateRecordResult<${dataType}>;
+}`);
+    lines.push('');
+    // DELETE mutation
+    lines.push(`export const DELETE_${upperSnake} = \`
+  mutation Delete${typeName}($id: ID!) {
+    deleteRecord(id: $id) { id }
+  }
+\`;`);
+    lines.push('');
+    lines.push(`export interface Delete${typeName}Variables {
+  id: string;
+}`);
+    lines.push('');
+    lines.push(`export interface Delete${typeName}Result {
+  deleteRecord: DeleteRecordResult;
+}`);
+    lines.push('');
+    // PUBLISH/UNPUBLISH
+    lines.push(`export const PUBLISH_${upperSnake}_VERSION = \`
+  mutation Publish${typeName}Version($versionId: ID!) {
+    publishVersion(versionId: $versionId)
+  }
+\`;`);
+    lines.push('');
+    lines.push(`export const UNPUBLISH_${upperSnake} = \`
+  mutation Unpublish${typeName}($id: ID!) {
+    unpublishRecord(id: $id)
+  }
+\`;`);
+    lines.push('');
+    // Sharing operations (conditional)
+    if (model.config.sharing?.enabled) {
+        lines.push(`// --- Sharing operations ---`);
+        lines.push('');
+        lines.push(`export const SHARE_${upperSnake} = \`
+  mutation Share${typeName}($recordId: ID!, $sharedWithCustomerId: ID!, $permission: SharePermission!) {
+    shareRecord(recordId: $recordId, sharedWithCustomerId: $sharedWithCustomerId, permission: $permission) {
+      id resourceType permission status acceptedAt declinedAt expiresAt createdAt revokedAt
+    }
+  }
+\`;`);
+        lines.push('');
+        lines.push(`export interface Share${typeName}Variables {
+  recordId: string;
+  sharedWithCustomerId: string;
+  permission: 'VIEW' | 'EDIT' | 'ADMIN';
+}`);
+        lines.push('');
+        lines.push(`export interface Share${typeName}Result {
+  shareRecord: ShareResult;
+}`);
+        lines.push('');
+        lines.push(`export const ${upperSnake}_SHARES = \`
+  query ${typeName}Shares($resourceId: ID!, $status: ShareStatus) {
+    shares(resourceType: RECORD, resourceId: $resourceId, status: $status) {
+      id resourceType permission status acceptedAt declinedAt expiresAt createdAt revokedAt
+    }
+  }
+\`;`);
+        lines.push('');
+        lines.push(`export const ${pluralUpperSnake}_SHARED_WITH_ME = \`
+  query ${pluralName}SharedWithMe($status: ShareStatus) {
+    sharedWithMe(resourceType: RECORD, modelKey: "${model.key}", status: $status) {
+      id resourceType permission status acceptedAt declinedAt expiresAt createdAt revokedAt
+      record {
+        id modelKey naturalKey data metadata
+        publishedVersionNumber publishedAt versionNumber changeDescription
+        createdAt updatedAt
+      }
+    }
+  }
+\`;`);
+        lines.push('');
+        lines.push(`export interface ${pluralName}SharedWithMeResult {
+  sharedWithMe: ShareWithRecord<${dataType}>[];
+}`);
+        lines.push('');
+    }
+    return lines.join('\n');
+}
+/**
+ * Compute the relative import path from the operations dir to the types dir.
+ */
+export function computeTypesRelPath(opsDir, typesDir) {
+    const rel = path.relative(opsDir, typesDir).replace(/\\/g, '/');
+    return rel.startsWith('.') ? rel : `./${rel}`;
+}

package/dist/commands/create-extension.d.ts

@@ -0,0 +1,4 @@
+import type { Command } from 'commander';
+import type { GlobalOptions } from '../lib/config.js';
+export declare function registerCreateExtensionCommand(program: Command, globalOpts: () => GlobalOptions): void;
+//# sourceMappingURL=create-extension.d.ts.map

package/dist/commands/create-extension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-extension.d.ts","sourceRoot":"","sources":["../../src/commands/create-extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAgBtD,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,MAAM,aAAa,GAC9B,IAAI,CA8DN"}

package/dist/commands/create-extension.js

@@ -0,0 +1,60 @@
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import { withErrorHandler } from '../lib/errors.js';
+import { scaffold } from '../scaffold/scaffold.js';
+const EXTENSION_TYPES = [
+    'custom-editor',
+    'workflow',
+    'widget',
+];
+function isValidExtensionType(value) {
+    return EXTENSION_TYPES.includes(value);
+}
+export function registerCreateExtensionCommand(program, globalOpts) {
+    program
+        .command('create-extension [name]')
+        .description('Scaffold a new Foir extension')
+        .option('--type <type>', 'Extension type: custom-editor, workflow, widget')
+        .option('--api-url <url>', 'Platform API URL', 'http://localhost:4000/graphql')
+        .action(withErrorHandler(globalOpts, async (name, cmdOpts) => {
+        console.log();
+        console.log(chalk.bold('  Create Foir Extension'));
+        console.log(chalk.gray('  ---------------------'));
+        console.log();
+        // Resolve name — use arg or prompt
+        let extensionName = name;
+        if (!extensionName) {
+            const { inputName } = await inquirer.prompt([
+                {
+                    type: 'input',
+                    name: 'inputName',
+                    message: 'Extension name:',
+                    default: 'my-extension',
+                },
+            ]);
+            extensionName = inputName;
+        }
+        // Resolve type — use flag or prompt
+        let extensionType;
+        if (cmdOpts?.type && isValidExtensionType(cmdOpts.type)) {
+            extensionType = cmdOpts.type;
+        }
+        else {
+            const { selectedType } = await inquirer.prompt([
+                {
+                    type: 'list',
+                    name: 'selectedType',
+                    message: 'Extension type:',
+                    choices: EXTENSION_TYPES,
+                    default: 'custom-editor',
+                },
+            ]);
+            extensionType = selectedType;
+        }
+        const apiUrl = cmdOpts?.apiUrl ?? 'http://localhost:4000/graphql';
+        console.log();
+        console.log(`  Scaffolding ${chalk.cyan(`"${extensionName}"`)} (${extensionType})...`);
+        console.log();
+        await scaffold(extensionName, extensionType, apiUrl);
+    }));
+}

package/dist/commands/pull.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pull.d.ts","sourceRoot":"","sources":["../../src/commands/pull.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAuBtD,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,MAAM,aAAa,GAC9B,IAAI,CAuMN"}
+{"version":3,"file":"pull.d.ts","sourceRoot":"","sources":["../../src/commands/pull.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAmCtD,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,MAAM,aAAa,GAC9B,IAAI,CA+TN"}