@aglyn/plugins-data 1.0.0-beta.221 → 1.0.0-beta.223

package/src/lib/transfer/dataset-transfer-resource.js

@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ /**
+ * The `data.dataset` server half (AGL-3530) as the console registers it at
+ * boot: every hook loads `dataset-transfer.server.ts` — and the Admin SDK and
+ * the job engine with it — on its first call, so a console process that
+ * never imports or exports a dataset pays nothing for it.
+ */ const hooks = async ()=>(await import("./dataset-transfer.server.js")).datasetTransferHooks();
+export const DATASET_TRANSFER_HOOKS = {
+    fields: async (ctx)=>(await hooks()).fields(ctx),
+    matchKeys: async (ctx)=>{
+        const matchKeys = (await hooks()).matchKeys;
+        return typeof matchKeys === 'function' ? matchKeys(ctx) : {
+            keys: matchKeys
+        };
+    },
+    count: async (ctx, options)=>(await hooks()).count(ctx, options),
+    readPage: async (ctx, cursor, fieldIds, options)=>(await hooks()).readPage(ctx, cursor, fieldIds, options),
+    lookup: async (ctx, requests)=>(await hooks()).lookup(ctx, requests),
+    suggest: async (ctx, request)=>(await hooks()).suggest(ctx, request),
+    picklists: async (ctx, picklistIds)=>(await hooks()).picklists(ctx, picklistIds),
+    addPicklistValues: async (ctx, picklistId, values)=>(await hooks()).addPicklistValues(ctx, picklistId, values),
+    plan: async (ctx, input)=>(await hooks()).plan(ctx, input),
+    apply: async (ctx, chunk, writer)=>(await hooks()).apply(ctx, chunk, writer),
+    revert: async (ctx, snapshot, decisions)=>(await hooks()).revert(ctx, snapshot, decisions)
+};
+
+//# sourceMappingURL=dataset-transfer-resource.js.map

package/src/lib/transfer/dataset-transfer-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/data/src/lib/transfer/dataset-transfer-resource.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  PluginTransferResource,\n  TransferRecordsHooks,\n} from '@aglyn/aglyn/plugin-manager/plugin-transfer-resources'\n\n/**\n * The `data.dataset` server half (AGL-3530) as the console registers it at\n * boot: every hook loads `dataset-transfer.server.ts` — and the Admin SDK and\n * the job engine with it — on its first call, so a console process that\n * never imports or exports a dataset pays nothing for it.\n */\nconst hooks = async (): Promise<TransferRecordsHooks> =>\n  (await import('./dataset-transfer.server')).datasetTransferHooks()\n\nexport const DATASET_TRANSFER_HOOKS: PluginTransferResource = {\n  fields: async (ctx) => (await hooks()).fields(ctx),\n  matchKeys: async (ctx) => {\n    const matchKeys = (await hooks()).matchKeys\n    return typeof matchKeys === 'function' ? matchKeys(ctx) : { keys: matchKeys }\n  },\n  count: async (ctx, options) => ((await hooks()).count as NonNullable<TransferRecordsHooks['count']>)(ctx, options),\n  readPage: async (ctx, cursor, fieldIds, options) => (await hooks()).readPage(ctx, cursor, fieldIds, options),\n  lookup: async (ctx, requests) => (await hooks()).lookup(ctx, requests),\n  suggest: async (ctx, request) =>\n    ((await hooks()).suggest as NonNullable<TransferRecordsHooks['suggest']>)(ctx, request),\n  picklists: async (ctx, picklistIds) =>\n    ((await hooks()).picklists as NonNullable<TransferRecordsHooks['picklists']>)(ctx, picklistIds),\n  addPicklistValues: async (ctx, picklistId, values) =>\n    ((await hooks()).addPicklistValues as NonNullable<TransferRecordsHooks['addPicklistValues']>)(ctx, picklistId, values),\n  plan: async (ctx, input) => ((await hooks()).plan as NonNullable<TransferRecordsHooks['plan']>)(ctx, input),\n  apply: async (ctx, chunk, writer) => (await hooks()).apply(ctx, chunk, writer),\n  revert: async (ctx, snapshot, decisions) => (await hooks()).revert(ctx, snapshot, decisions),\n}\n"],"names":["hooks","datasetTransferHooks","DATASET_TRANSFER_HOOKS","fields","ctx","matchKeys","keys","count","options","readPage","cursor","fieldIds","lookup","requests","suggest","request","picklists","picklistIds","addPicklistValues","picklistId","values","plan","input","apply","chunk","writer","revert","snapshot","decisions"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAOD;;;;;CAKC,GACD,MAAMA,QAAQ,UACZ,AAAC,CAAA,MAAM,MAAM,CAAC,+BAA2B,EAAGC,oBAAoB;AAElE,OAAO,MAAMC,yBAAiD;IAC5DC,QAAQ,OAAOC,MAAQ,AAAC,CAAA,MAAMJ,OAAM,EAAGG,MAAM,CAACC;IAC9CC,WAAW,OAAOD;QAChB,MAAMC,YAAY,AAAC,CAAA,MAAML,OAAM,EAAGK,SAAS;QAC3C,OAAO,OAAOA,cAAc,aAAaA,UAAUD,OAAO;YAAEE,MAAMD;QAAU;IAC9E;IACAE,OAAO,OAAOH,KAAKI,UAAY,AAAC,AAAC,CAAA,MAAMR,OAAM,EAAGO,KAAK,CAAgDH,KAAKI;IAC1GC,UAAU,OAAOL,KAAKM,QAAQC,UAAUH,UAAY,AAAC,CAAA,MAAMR,OAAM,EAAGS,QAAQ,CAACL,KAAKM,QAAQC,UAAUH;IACpGI,QAAQ,OAAOR,KAAKS,WAAa,AAAC,CAAA,MAAMb,OAAM,EAAGY,MAAM,CAACR,KAAKS;IAC7DC,SAAS,OAAOV,KAAKW,UACnB,AAAC,AAAC,CAAA,MAAMf,OAAM,EAAGc,OAAO,CAAkDV,KAAKW;IACjFC,WAAW,OAAOZ,KAAKa,cACrB,AAAC,AAAC,CAAA,MAAMjB,OAAM,EAAGgB,SAAS,CAAoDZ,KAAKa;IACrFC,mBAAmB,OAAOd,KAAKe,YAAYC,SACzC,AAAC,AAAC,CAAA,MAAMpB,OAAM,EAAGkB,iBAAiB,CAA4Dd,KAAKe,YAAYC;IACjHC,MAAM,OAAOjB,KAAKkB,QAAU,AAAC,AAAC,CAAA,MAAMtB,OAAM,EAAGqB,IAAI,CAA+CjB,KAAKkB;IACrGC,OAAO,OAAOnB,KAAKoB,OAAOC,SAAW,AAAC,CAAA,MAAMzB,OAAM,EAAGuB,KAAK,CAACnB,KAAKoB,OAAOC;IACvEC,QAAQ,OAAOtB,KAAKuB,UAAUC,YAAc,AAAC,CAAA,MAAM5B,OAAM,EAAG0B,MAAM,CAACtB,KAAKuB,UAAUC;AACpF,EAAC"}

package/src/lib/transfer/dataset-transfer.server.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type MatchLookupRequest, type PlannedTransferRow, type TransferLookupSuggestion, type TransferUndoEntry } from '@aglyn/aglyn/data-transfer';
+import type { PicklistValue } from '@aglyn/aglyn/app-utils/picklists';
+import type { TransferApplyResult, TransferApplyWriter, TransferLookupResult, TransferLookupSuggestRequest, TransferPicklistList, TransferReadOptions, TransferReadPage, TransferRecordsHooks, TransferResourceContext, TransferRevertDecisions, TransferRevertResult } from '@aglyn/aglyn/plugin-manager/plugin-transfer-resources';
+import type { ListFilterClause } from '@aglyn/shared-ui-jsx/const/list-grid-filter';
+import { type Firestore } from 'firebase-admin/firestore';
+/** What the hooks run against; a spec hands in a double. */
+export interface DatasetTransferDeps {
+    firestore: Firestore;
+}
+/**
+ * The id a record created by an import's row is given: ten characters of the
+ * resource-id alphabet, derived from the job and the row, so a retried chunk
+ * names the record it already wrote rather than writing a second one.
+ */
+export declare function transferRecordId(jobId: string, row: number): string;
+/** The records table's filter as the Data card sends it: the grid's clauses and the search words. */
+export interface DatasetTransferFilter {
+    clauses: ListFilterClause[];
+    search: string[];
+}
+export declare function countDatasetRecords(deps: DatasetTransferDeps, ctx: TransferResourceContext, options: TransferReadOptions): Promise<number>;
+export declare function readDatasetPage(deps: DatasetTransferDeps, ctx: TransferResourceContext, cursor: string | null, fieldIds: readonly string[], options?: TransferReadOptions): Promise<TransferReadPage>;
+export declare function lookupDatasetRecords(deps: DatasetTransferDeps, ctx: TransferResourceContext, requests: readonly MatchLookupRequest[]): Promise<TransferLookupResult>;
+/**
+ * Records named LIKE each value a reference could not find, for the person
+ * to pick from: each plain text `by` field asked for records with a word that
+ * starts with one of the value's first words, or with its first few letters
+ * (the `filterKeys` prefix tokens the records table's `contains` reads), then
+ * ranked by how close the whole name is. Values past the query budget get none.
+ */
+export declare function suggestDatasetRecords(deps: DatasetTransferDeps, ctx: TransferResourceContext, request: TransferLookupSuggestRequest): Promise<Record<string, TransferLookupSuggestion[]>>;
+export declare function datasetPicklists(deps: DatasetTransferDeps, ctx: TransferResourceContext, picklistIds: readonly string[]): Promise<Record<string, TransferPicklistList>>;
+/**
+ * The values the person chose to add to an options field, added to the
+ * field's options in the dataset's model — the schema the Schema dialog
+ * edits — before the import's first write. A value already there is left.
+ */
+export declare function addDatasetOptions(deps: DatasetTransferDeps, ctx: TransferResourceContext, picklistId: string, values: readonly PicklistValue[]): Promise<void>;
+/**
+ * The id a record created for a reference's name is given: ten characters
+ * of the resource-id alphabet, from the job, the target, the field it is
+ * named in and the name as the engine keys it — so every row naming it, in
+ * any chunk, and a retried chunk all land on the one record.
+ */
+export declare function transferReferenceRecordId(jobId: string, datasetId: string, displayFieldId: string, name: string): string;
+export declare function applyDatasetChunk(deps: DatasetTransferDeps, ctx: TransferResourceContext, chunk: {
+    rows: PlannedTransferRow[];
+}, writer: TransferApplyWriter): Promise<TransferApplyResult>;
+export declare function revertDatasetChunk(deps: DatasetTransferDeps, ctx: TransferResourceContext, snapshot: {
+    entries: TransferUndoEntry[];
+}, decisions?: TransferRevertDecisions): Promise<TransferRevertResult>;
+/** The records hooks for `data.dataset`, over `deps` (the Admin SDK's Firestore by default). */
+export declare function datasetTransferHooks(deps?: () => DatasetTransferDeps): TransferRecordsHooks;