@sprigr/apps-app-sdk 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -589,6 +589,89 @@ interface SprigrFilesApi {
         key: string;
     }>;
 }
+/**
+ * Platform document-engine bridge types (`env.SPRIGR.files.edit` / `.create`
+ * / `.job`). Canonical declaration: previously copied consumer-side into
+ * microsoft-365 and google-workspace to avoid a repo-wide vendor re-sync;
+ * upstreamed here once two live consumers shipped (m365 0.15/0.16,
+ * google-workspace 0.4).
+ */
+/** Input to `env.SPRIGR.files.edit` (the platform surgical document edit bridge). */
+interface SprigrFilesEditInput {
+    /** App-relative key of the source file already in app storage. */
+    file_key: string;
+    /** pdf runs the PyMuPDF ops engine (list_fields / fill_form / replace_text);
+     *  docx/xlsx run python-docx / openpyxl; xer/pmxml/mspdi run the platform's
+     *  pure-TS schedule engine in-worker (Primavera P6 / MS Project XML, no
+     *  sandbox cold-start exposure). */
+    format: 'docx' | 'xlsx' | 'pdf' | 'xer' | 'pmxml' | 'mspdi';
+    operations: Array<Record<string, unknown>>;
+    output_filename?: string;
+    output_key?: string;
+    allow_lossy?: boolean;
+    /** Schedule formats only: write even when the FK-integrity gate finds
+     *  errors (the validation result is still returned). */
+    skip_validation?: boolean;
+    /** Deterministic idempotency token: the platform persists the pipeline's
+     *  terminal result under it, so a retry of the same logical edit after a
+     *  dispatch timeout replays the finished result instead of re-running the
+     *  engine. Filename-safe: ^[A-Za-z0-9_-]{8,128}$. */
+    job_token?: string;
+}
+/** Result from `env.SPRIGR.files.edit`. */
+interface SprigrFilesEditResult {
+    ok: boolean;
+    out_file_key?: string;
+    size?: number;
+    operations_applied?: Array<Record<string, unknown>>;
+    failed_operations?: Array<Record<string, unknown>>;
+    warning?: string;
+    error?: string;
+    /** Schedule formats only: the FK-integrity result ({errorCount, warningCount, issues}). */
+    validation?: Record<string, unknown>;
+    /** Schedule formats only: one-line engine summary incl. matched counts. */
+    summary?: string;
+}
+/** Input to `env.SPRIGR.files.create` (build a NEW docx/xlsx from a spec). */
+interface SprigrFilesCreateInput {
+    format: 'docx' | 'xlsx';
+    /** docx: content blocks (heading/paragraph/table/…). xlsx: sheet defs ({name, headers, rows, …}). */
+    spec: Array<Record<string, unknown>>;
+    properties?: Record<string, unknown>;
+    output_filename?: string;
+    output_key?: string;
+    /** Same idempotency semantics as SprigrFilesEditInput.job_token. */
+    job_token?: string;
+}
+/** Result from `env.SPRIGR.files.create`. */
+interface SprigrFilesCreateResult {
+    ok: boolean;
+    out_file_key?: string;
+    size?: number;
+    error?: string;
+}
+/** Result from `env.SPRIGR.files.job` (read-only job-record status). */
+interface SprigrFilesJobResult {
+    ok: boolean;
+    job_token: string;
+    status: 'not_found' | 'running' | 'done' | 'error';
+    /** True when the record is older than the platform's freshness windows
+     *  (an orphaned `running` or an expired terminal record). */
+    stale?: boolean;
+    started_at?: number;
+    finished_at?: number;
+    http_status?: number;
+    /** The stored edit/create response body (terminal records only). */
+    result?: Record<string, unknown>;
+}
+/** The platform files bridge plus the document-engine methods. */
+interface SprigrFilesApiWithEdit extends SprigrFilesApi {
+    edit(input: SprigrFilesEditInput): Promise<SprigrFilesEditResult>;
+    create(input: SprigrFilesCreateInput): Promise<SprigrFilesCreateResult>;
+    /** Optional: absent on wrapper builds older than the job-token surface;
+     *  callers must feature-detect. */
+    job?(jobToken: string): Promise<SprigrFilesJobResult>;
+}
 /** Narrow structural type for the per-install D1 binding. */
 interface D1Like {
     prepare(sql: string): D1PreparedStatementLike;
@@ -626,4 +709,4 @@ interface ExecutionContextLike {
 }
 type HandlerFn<TArgs, TResult> = (args: TArgs, env: Record<string, unknown>, ctx?: ExecutionContextLike) => Promise<TResult>;
 
-export { type Actor, type AppFileListItem, type AppFileUrlArgs, type AppFileUrlResult, type AppFilesEnv, type D1Like, type D1PreparedStatementLike, DEFAULT_MAX_FILE_BYTES, type EventArgs, type ExecutionContextLike, type FetchFileResult, type FetchWithRetryOptions, type GetAppFileResult, type HandlerFn, type MarketplaceEventEmitOpts, type MarketplaceEventSourceIntegration, type OAuthState, type PlatformHostEnv, type PutAppFileArgs, type PutAppFileResult, type PutAppFileStreamArgs, type ScheduleArgs, type SprigrDataApi, type SprigrDataSearchOpts, type SprigrDataSearchResult, type SprigrFilesApi, type WebhookArgs, actorKey, appFileUrl, base64ToBytes, buildMarketplaceWebhookUrl, bytesToBase64, constantTimeEqual, decodeState, deleteAppFile, encodeState, fetchFileAsBase64, fetchFileBytes, fetchWithRetry, getAppFile, hmacSha256Hex, listAppFiles, parseActor, putAppFile, putAppFileStream, randomHex, resolvePlatformWebhookBase };
+export { type Actor, type AppFileListItem, type AppFileUrlArgs, type AppFileUrlResult, type AppFilesEnv, type D1Like, type D1PreparedStatementLike, DEFAULT_MAX_FILE_BYTES, type EventArgs, type ExecutionContextLike, type FetchFileResult, type FetchWithRetryOptions, type GetAppFileResult, type HandlerFn, type MarketplaceEventEmitOpts, type MarketplaceEventSourceIntegration, type OAuthState, type PlatformHostEnv, type PutAppFileArgs, type PutAppFileResult, type PutAppFileStreamArgs, type ScheduleArgs, type SprigrDataApi, type SprigrDataSearchOpts, type SprigrDataSearchResult, type SprigrFilesApi, type SprigrFilesApiWithEdit, type SprigrFilesCreateInput, type SprigrFilesCreateResult, type SprigrFilesEditInput, type SprigrFilesEditResult, type SprigrFilesJobResult, type WebhookArgs, actorKey, appFileUrl, base64ToBytes, buildMarketplaceWebhookUrl, bytesToBase64, constantTimeEqual, decodeState, deleteAppFile, encodeState, fetchFileAsBase64, fetchFileBytes, fetchWithRetry, getAppFile, hmacSha256Hex, listAppFiles, parseActor, putAppFile, putAppFileStream, randomHex, resolvePlatformWebhookBase };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sprigr/apps-app-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",