@zveltio/sdk 3.0.0-beta.4 → 3.0.0-beta.68

package/dist/validate/shared-message-keys.js

@@ -0,0 +1,227 @@
+/**
+ * GENERATED — do not edit. Run `bun run scripts/sync-shared-message-keys.ts`.
+ *
+ * The subset of the Studio's core message catalogue that extensions may use
+ * in SDUI schemas without shipping the key themselves: the generic vocabulary
+ * (`common.*`) plus the shared extension helpers (`ext.*`).
+ *
+ * An extension that needs anything else must ship it in its own
+ * `studio/messages/{locale}.json` — otherwise it renders correctly only on a
+ * host whose core catalogue happens to know about it, which is not a property
+ * an installable extension should depend on.
+ *
+ * Source: packages/studio/messages/core/en.json (211 keys)
+ */
+export const SHARED_MESSAGE_KEYS = new Set([
+    'common.accessRestricted',
+    'common.actions',
+    'common.add',
+    'common.added',
+    'common.aiStudio',
+    'common.approve',
+    'common.assign',
+    'common.bulkActions',
+    'common.cancel',
+    'common.cancelEdit',
+    'common.clear',
+    'common.clearSelection',
+    'common.close',
+    'common.col.account',
+    'common.col.active',
+    'common.col.address',
+    'common.col.amount',
+    'common.col.balance',
+    'common.col.bank',
+    'common.col.bcc',
+    'common.col.category',
+    'common.col.cc',
+    'common.col.channel',
+    'common.col.client',
+    'common.col.code',
+    'common.col.collection',
+    'common.col.company',
+    'common.col.created',
+    'common.col.credit',
+    'common.col.currency',
+    'common.col.date',
+    'common.col.days',
+    'common.col.debit',
+    'common.col.department',
+    'common.col.description',
+    'common.col.docNumber',
+    'common.col.dueDate',
+    'common.col.duration',
+    'common.col.email',
+    'common.col.employee',
+    'common.col.enabled',
+    'common.col.end',
+    'common.col.event',
+    'common.col.field',
+    'common.col.file',
+    'common.col.from',
+    'common.col.hireDate',
+    'common.col.host',
+    'common.col.iban',
+    'common.col.index',
+    'common.col.key',
+    'common.col.label',
+    'common.col.leaveType',
+    'common.col.locale',
+    'common.col.message',
+    'common.col.method',
+    'common.col.model',
+    'common.col.name',
+    'common.col.notes',
+    'common.col.number',
+    'common.col.paid',
+    'common.col.parent',
+    'common.col.password',
+    'common.col.path',
+    'common.col.phone',
+    'common.col.port',
+    'common.col.position',
+    'common.col.price',
+    'common.col.priority',
+    'common.col.product',
+    'common.col.project',
+    'common.col.provider',
+    'common.col.quantity',
+    'common.col.reason',
+    'common.col.recipient',
+    'common.col.records',
+    'common.col.required',
+    'common.col.resource',
+    'common.col.role',
+    'common.col.sku',
+    'common.col.slug',
+    'common.col.start',
+    'common.col.status',
+    'common.col.subject',
+    'common.col.taxId',
+    'common.col.template',
+    'common.col.ticket',
+    'common.col.time',
+    'common.col.title',
+    'common.col.to',
+    'common.col.total',
+    'common.col.type',
+    'common.col.unique',
+    'common.col.unit',
+    'common.col.user',
+    'common.col.username',
+    'common.col.validUntil',
+    'common.col.value',
+    'common.col.vat',
+    'common.col.vendor',
+    'common.col.version',
+    'common.col.warehouse',
+    'common.col.year',
+    'common.collectionRequired',
+    'common.confirm',
+    'common.copied',
+    'common.copy',
+    'common.copyShort',
+    'common.create',
+    'common.delete',
+    'common.deleteCount',
+    'common.deleteFailed',
+    'common.discard',
+    'common.dismiss',
+    'common.dismissNotification',
+    'common.done',
+    'common.download',
+    'common.edit',
+    'common.emptyDash',
+    'common.failed',
+    'common.fields',
+    'common.filter.admin',
+    'common.filter.all',
+    'common.filter.allStatuses',
+    'common.filter.auth',
+    'common.filter.data',
+    'common.format',
+    'common.generate',
+    'common.loadFailed',
+    'common.loading',
+    'common.logout',
+    'common.manage',
+    'common.mergeFailed',
+    'common.nameRequired',
+    'common.new',
+    'common.next',
+    'common.no',
+    'common.noResults',
+    'common.notFound',
+    'common.op.delete',
+    'common.op.insert',
+    'common.op.update',
+    'common.open',
+    'common.optional',
+    'common.optionalParen',
+    'common.other',
+    'common.pageOf',
+    'common.post',
+    'common.prev',
+    'common.publish',
+    'common.rangeOf',
+    'common.refresh',
+    'common.reject',
+    'common.remove',
+    'common.rename',
+    'common.reorder',
+    'common.required',
+    'common.resetFailed',
+    'common.retry',
+    'common.revoke',
+    'common.save',
+    'common.saveFailed',
+    'common.saved',
+    'common.saving',
+    'common.search',
+    'common.selectCollection',
+    'common.selectPlaceholder',
+    'common.selected',
+    'common.send',
+    'common.somethingWrong',
+    'common.status.approved',
+    'common.status.cancelled',
+    'common.status.draft',
+    'common.status.pending',
+    'common.status.reimbursed',
+    'common.status.rejected',
+    'common.status.submitted',
+    'common.submit',
+    'common.sync',
+    'common.testConnection',
+    'common.typeToSearch',
+    'common.undo',
+    'common.unexpectedError',
+    'common.unknownError',
+    'common.upload',
+    'common.uploadFailed',
+    'common.uploading',
+    'common.verifyingPermissions',
+    'common.view',
+    'common.viewAll',
+    'common.yes',
+    'ext.approved',
+    'ext.confirm.deleteForm',
+    'ext.confirm.deleteNamed',
+    'ext.confirm.removeSearchIndex',
+    'ext.confirmDelete',
+    'ext.copied',
+    'ext.copyFailed',
+    'ext.created',
+    'ext.deleted',
+    'ext.errorPrefix',
+    'ext.linkCopied',
+    'ext.loadFailed',
+    'ext.rejected',
+    'ext.reveal.copy',
+    'ext.reveal.note',
+    'ext.reveal.title',
+    'ext.saveFailed',
+    'ext.saved',
+    'ext.sent',
+    'ext.submitted',
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zveltio/sdk",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0-beta.68",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -61,15 +61,15 @@
     "test": "bun test --preload ./src/tests/setup.ts"
   },
   "dependencies": {
-    "idb": "^8.0.0"
+    "idb": "^8.0.3"
   },
   "devDependencies": {
-    "@testcontainers/postgresql": "^11.0.0",
-    "@types/pg": "^8.11.0",
+    "@testcontainers/postgresql": "^11.14.0",
+    "@types/pg": "^8.23.1",
     "fake-indexeddb": "^6.2.5",
-    "hono": "^4.12.5",
-    "kysely": "^0.27.0",
-    "pg": "^8.13.0",
+    "hono": "^4.13.8",
+    "kysely": "^0.29.6",
+    "pg": "^8.23.0",
     "typescript": "^5.4.0"
   },
   "peerDependencies": {

package/dist/generate-types.d.ts

@@ -1,37 +0,0 @@
-/**
- * generate-types.ts
- *
- * Programmatic type generator for Zveltio collections.
- * Fetches collection schemas from a running Zveltio engine and generates
- * TypeScript interface declarations with full type information.
- *
- * Usage (programmatic):
- *   import { generateTypes } from '@zveltio/sdk/generate-types';
- *   const dts = await generateTypes({ url: 'http://localhost:3000', apiKey: 'sk-...' });
- *   await fs.writeFile('./types/zveltio.d.ts', dts);
- *
- * Usage (CLI):
- *   zveltio generate-types --output ./types/zveltio.d.ts
- *   zveltio types --output ./types/zveltio.d.ts
- */
-export interface GenerateTypesOptions {
-    /** Zveltio engine URL (default: http://localhost:3000) */
-    url?: string;
-    /** API key for authentication */
-    apiKey?: string;
-    /** Only generate types for this collection */
-    collection?: string;
-}
-/**
- * Generates TypeScript declarations for all (or one) Zveltio collection(s).
- *
- * Returns the `.d.ts` file content as a string. The caller is responsible for
- * writing it to disk.
- *
- * The engine endpoint `/api/admin/types` is used when available (returns
- * pre-generated TS from the server's field-type registry). If the endpoint
- * fails or is unavailable this function falls back to generating types from
- * the collection schema returned by `/api/collections`.
- */
-export declare function generateTypes(options?: GenerateTypesOptions): Promise<string>;
-//# sourceMappingURL=generate-types.d.ts.map

package/dist/generate-types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-types.d.ts","sourceRoot":"","sources":["../src/generate-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AA0HH,MAAM,WAAW,oBAAoB;IACnC,0DAA0D;IAC1D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC,CAyDvF"}

package/dist/generate-types.js

@@ -1,157 +0,0 @@
-/**
- * generate-types.ts
- *
- * Programmatic type generator for Zveltio collections.
- * Fetches collection schemas from a running Zveltio engine and generates
- * TypeScript interface declarations with full type information.
- *
- * Usage (programmatic):
- *   import { generateTypes } from '@zveltio/sdk/generate-types';
- *   const dts = await generateTypes({ url: 'http://localhost:3000', apiKey: 'sk-...' });
- *   await fs.writeFile('./types/zveltio.d.ts', dts);
- *
- * Usage (CLI):
- *   zveltio generate-types --output ./types/zveltio.d.ts
- *   zveltio types --output ./types/zveltio.d.ts
- */
-// ── Field type → TypeScript type mapping ─────────────────────────────────────
-const FIELD_TYPE_MAP = {
-    text: 'string',
-    textarea: 'string',
-    richtext: 'string',
-    markdown: 'string',
-    email: 'string',
-    url: 'string',
-    password: 'string',
-    slug: 'string',
-    uuid: 'string',
-    color: 'string',
-    number: 'number',
-    integer: 'number',
-    decimal: 'number',
-    float: 'number',
-    currency: 'number',
-    percentage: 'number',
-    boolean: 'boolean',
-    toggle: 'boolean',
-    date: 'string', // ISO 8601 date string
-    datetime: 'string', // ISO 8601 datetime string
-    time: 'string',
-    timestamp: 'string',
-    json: 'Record<string, unknown>',
-    jsonb: 'Record<string, unknown>',
-    object: 'Record<string, unknown>',
-    array: 'unknown[]',
-    tags: 'string[]',
-    select: 'string',
-    multiselect: 'string[]',
-    relation: 'string', // UUID of related record
-    file: 'string', // storage path
-    image: 'string', // storage path
-    point: '{ lat: number; lng: number }',
-    geojson: 'GeoJSON.Geometry',
-};
-function fieldTypeToTs(fieldType) {
-    return FIELD_TYPE_MAP[fieldType.toLowerCase()] ?? 'unknown';
-}
-/**
- * Converts a collection name (snake_case) to a PascalCase interface name.
- * Examples: "my_orders" → "MyOrders", "products" → "Products"
- */
-function toPascalCase(name) {
-    return name
-        .split(/[_\s-]+/)
-        .map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase())
-        .join('');
-}
-function generateCollectionInterface(col) {
-    const interfaceName = toPascalCase(col.name) + 'Collection';
-    const fields = col.fields ?? [];
-    const lines = [];
-    if (col.description) {
-        lines.push(`/** ${col.description} */`);
-    }
-    lines.push(`export interface ${interfaceName} {`);
-    lines.push(`  /** Internal record ID (UUID) */`);
-    lines.push(`  id: string;`);
-    for (const field of fields) {
-        if (field.description) {
-            lines.push(`  /** ${field.description} */`);
-        }
-        const tsType = fieldTypeToTs(field.type);
-        const optional = field.required ? '' : '?';
-        lines.push(`  ${field.name}${optional}: ${tsType};`);
-    }
-    lines.push(`  /** ISO 8601 creation timestamp */`);
-    lines.push(`  created_at: string;`);
-    lines.push(`  /** ISO 8601 last-updated timestamp */`);
-    lines.push(`  updated_at: string;`);
-    lines.push(`}`);
-    return lines.join('\n');
-}
-function generateIndexInterface(collections) {
-    const lines = [];
-    lines.push(`/** Index of all Zveltio collections — use with \`ZveltioClient<ZveltioCollections>\` */`);
-    lines.push(`export interface ZveltioCollections {`);
-    for (const col of collections) {
-        const interfaceName = toPascalCase(col.name) + 'Collection';
-        const comment = col.display_name || col.name;
-        lines.push(`  /** ${comment} */`);
-        lines.push(`  ${col.name}: ${interfaceName};`);
-    }
-    lines.push(`}`);
-    return lines.join('\n');
-}
-/**
- * Generates TypeScript declarations for all (or one) Zveltio collection(s).
- *
- * Returns the `.d.ts` file content as a string. The caller is responsible for
- * writing it to disk.
- *
- * The engine endpoint `/api/admin/types` is used when available (returns
- * pre-generated TS from the server's field-type registry). If the endpoint
- * fails or is unavailable this function falls back to generating types from
- * the collection schema returned by `/api/collections`.
- */
-export async function generateTypes(options = {}) {
-    const engineUrl = (options.url ?? process.env.ZVELTIO_URL ?? 'http://localhost:3000').replace(/\/$/, '');
-    const apiKey = options.apiKey ?? process.env.ZVELTIO_API_KEY ?? '';
-    const headers = {};
-    if (apiKey)
-        headers['Authorization'] = `Bearer ${apiKey}`;
-    // ── Try fast path: engine pre-generates types ────────────────────────────
-    try {
-        const path = options.collection
-            ? `/api/admin/types/${encodeURIComponent(options.collection)}`
-            : '/api/admin/types';
-        const res = await fetch(`${engineUrl}${path}`, { headers });
-        if (res.ok) {
-            return await res.text();
-        }
-        // Fall through to manual generation on 404/401/500
-        if (res.status !== 404) {
-            console.warn(`[generate-types] Engine /api/admin/types returned ${res.status}, falling back to manual generation.`);
-        }
-    }
-    catch {
-        // Engine unreachable or endpoint absent — use fallback
-    }
-    // ── Fallback: fetch schema and generate types locally ────────────────────
-    const collectionsUrl = options.collection
-        ? `${engineUrl}/api/collections/${encodeURIComponent(options.collection)}`
-        : `${engineUrl}/api/collections`;
-    const res = await fetch(collectionsUrl, { headers });
-    if (!res.ok) {
-        throw new Error(`Failed to fetch collections from ${collectionsUrl}: ${res.status} ${res.statusText}`);
-    }
-    const data = (await res.json());
-    const collections = Array.isArray(data.collections)
-        ? data.collections.filter((c) => !c.is_system)
-        : data.collection
-            ? [data.collection]
-            : [];
-    const header = `// Auto-generated by Zveltio\n// Do not edit manually — run: zveltio generate-types\n// Generated: ${new Date().toISOString()}\n`;
-    const interfaces = collections.map(generateCollectionInterface).join('\n\n');
-    const indexType = options.collection ? '' : '\n\n' + generateIndexInterface(collections);
-    return `${header}\n${interfaces}${indexType}\n`;
-}