@flyingrobots/bijou-i18n-tools 4.4.1 → 5.0.0

package/README.md

@@ -11,6 +11,7 @@ Workflow and authoring tooling for Bijou localization.
 - CSV/TSV sheet serialization and parsing
 - serializable catalog-bundle export/import
 - JSON bundle serialization and parsing
+- provider-neutral async service adapter ports for workbook and bundle exchange
 - typed value encoding/decoding for strings, data, and refs
 - reference validation and normalization
 - compilation into `@flyingrobots/bijou-i18n` runtime catalogs
@@ -18,6 +19,26 @@ Workflow and authoring tooling for Bijou localization.
 
 This package is intentionally provider-neutral. Filesystem, XLSX, or service-backed adapters can sit on top of it without polluting the core tooling API.
 
+Service-backed workflows can use the built-in async adapter ports without
+pulling remote service details into the tooling core:
+
+```typescript
+import { pushTranslationWorkbookToService, type ExchangeWorkbookServiceAdapter } from '@flyingrobots/bijou-i18n-tools';
+
+const adapter: ExchangeWorkbookServiceAdapter = {
+  pull: async () => ({ value: existingWorkbook, revision: 'rev-1' }),
+  push: async (snapshot) => snapshot,
+};
+
+await pushTranslationWorkbookToService(adapter, catalogs, 'de', {
+  revision: 'rev-1',
+});
+```
+
+Concrete Google Sheets or other remote service clients should live outside this
+package and implement the adapter contract on top of the existing workbook or
+bundle exchange shapes.
+
 ## Documentation
 
 See the [Bijou repo](https://github.com/flyingrobots/bijou) for the full documentation map, architecture guide, and design system.

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { parseCatalogBundleJson, parseExchangeSheet, serializeCatalogBundleJson, serializeExchangeSheet, type DelimitedFormat, } from './adapters.js';
 export { decodeExchangeValue, encodeExchangeValue, exportCatalogBundle, exportTranslationWorkbook, importCatalogBundle, importTranslationWorkbook, type CatalogBundle, type EncodedExchangeValue, type ExchangeSheet, type ExchangeValueKind, type ExchangeWorkbook, type SerializedAuthoringCatalog, type SerializedAuthoringCatalogEntry, type SerializedAuthoringTranslation, type TranslationWorkbookRow, } from './exchange.js';
 export { compileCatalogs, exportTranslationRows, hashSourceValue, importTranslationRows, markStaleTranslations, pseudoLocalize, ref, type AuthoringCatalog, type AuthoringCatalogEntry, type AuthoringTranslation, type AuthoringTranslationStatus, type TranslationRow, } from './tools.js';
+export { pullCatalogBundleFromService, pullTranslationWorkbookFromService, pushCatalogBundleToService, pushTranslationWorkbookToService, type CatalogBundleServiceAdapter, type CatalogBundleServicePullResult, type ExchangeWorkbookServiceAdapter, type ServiceExchangeAdapter, type ServiceExchangeSnapshot, type TranslationWorkbookServicePullResult, } from './service.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,0BAA0B,EAC1B,sBAAsB,EACtB,KAAK,eAAe,GACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,EACzB,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,sBAAsB,GAC5B,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,GAAG,EACH,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,cAAc,GACpB,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,0BAA0B,EAC1B,sBAAsB,EACtB,KAAK,eAAe,GACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,EACzB,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,sBAAsB,GAC5B,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,GAAG,EACH,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,cAAc,GACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,4BAA4B,EAC5B,kCAAkC,EAClC,0BAA0B,EAC1B,gCAAgC,EAChC,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,8BAA8B,EACnC,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,oCAAoC,GAC1C,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -1,4 +1,5 @@
 export { parseCatalogBundleJson, parseExchangeSheet, serializeCatalogBundleJson, serializeExchangeSheet, } from './adapters.js';
 export { decodeExchangeValue, encodeExchangeValue, exportCatalogBundle, exportTranslationWorkbook, importCatalogBundle, importTranslationWorkbook, } from './exchange.js';
 export { compileCatalogs, exportTranslationRows, hashSourceValue, importTranslationRows, markStaleTranslations, pseudoLocalize, ref, } from './tools.js';
+export { pullCatalogBundleFromService, pullTranslationWorkbookFromService, pushCatalogBundleToService, pushTranslationWorkbookToService, } from './service.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,0BAA0B,EAC1B,sBAAsB,GAEvB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,GAU1B,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,GAAG,GAMJ,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,0BAA0B,EAC1B,sBAAsB,GAEvB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,GAU1B,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,GAAG,GAMJ,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,4BAA4B,EAC5B,kCAAkC,EAClC,0BAA0B,EAC1B,gCAAgC,GAOjC,MAAM,cAAc,CAAC"}

package/dist/service.d.ts

@@ -0,0 +1,25 @@
+import type { CatalogBundle, ExchangeWorkbook } from './exchange.js';
+import type { AuthoringCatalog, TranslationRow } from './tools.js';
+export interface ServiceExchangeSnapshot<T> {
+    readonly value: T;
+    readonly revision?: string;
+}
+export interface ServiceExchangeAdapter<T> {
+    pull(): Promise<ServiceExchangeSnapshot<T>>;
+    push(snapshot: ServiceExchangeSnapshot<T>): Promise<ServiceExchangeSnapshot<T>>;
+}
+export type ExchangeWorkbookServiceAdapter = ServiceExchangeAdapter<ExchangeWorkbook>;
+export type CatalogBundleServiceAdapter = ServiceExchangeAdapter<CatalogBundle>;
+export interface TranslationWorkbookServicePullResult {
+    readonly snapshot: ServiceExchangeSnapshot<ExchangeWorkbook>;
+    readonly rows: readonly TranslationRow[];
+}
+export interface CatalogBundleServicePullResult {
+    readonly snapshot: ServiceExchangeSnapshot<CatalogBundle>;
+    readonly catalogs: readonly AuthoringCatalog[];
+}
+export declare function pullTranslationWorkbookFromService(adapter: ExchangeWorkbookServiceAdapter): Promise<TranslationWorkbookServicePullResult>;
+export declare function pushTranslationWorkbookToService(adapter: ExchangeWorkbookServiceAdapter, catalogs: readonly AuthoringCatalog[], locale: string, snapshot?: Omit<ServiceExchangeSnapshot<ExchangeWorkbook>, 'value'>): Promise<ServiceExchangeSnapshot<ExchangeWorkbook>>;
+export declare function pullCatalogBundleFromService(adapter: CatalogBundleServiceAdapter): Promise<CatalogBundleServicePullResult>;
+export declare function pushCatalogBundleToService(adapter: CatalogBundleServiceAdapter, catalogs: readonly AuthoringCatalog[], snapshot?: Omit<ServiceExchangeSnapshot<CatalogBundle>, 'value'>): Promise<ServiceExchangeSnapshot<CatalogBundle>>;
+//# sourceMappingURL=service.d.ts.map

package/dist/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAErE,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEnE,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,IAAI,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,IAAI,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;CACjF;AAED,MAAM,MAAM,8BAA8B,GAAG,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;AACtF,MAAM,MAAM,2BAA2B,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC;AAEhF,MAAM,WAAW,oCAAoC;IACnD,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,SAAS,cAAc,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;IAC1D,QAAQ,CAAC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,CAAC;CAChD;AAED,wBAAsB,kCAAkC,CACtD,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,oCAAoC,CAAC,CAM/C;AAED,wBAAsB,gCAAgC,CACpD,OAAO,EAAE,8BAA8B,EACvC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,EACrC,MAAM,EAAE,MAAM,EACd,QAAQ,GAAE,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAM,GACtE,OAAO,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,CAKpD;AAED,wBAAsB,4BAA4B,CAChD,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,8BAA8B,CAAC,CAMzC;AAED,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,2BAA2B,EACpC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,EACrC,QAAQ,GAAE,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,EAAE,OAAO,CAAM,GACnE,OAAO,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,CAKjD"}

package/dist/service.js

@@ -0,0 +1,28 @@
+import { exportCatalogBundle, exportTranslationWorkbook, importCatalogBundle, importTranslationWorkbook } from './exchange.js';
+export async function pullTranslationWorkbookFromService(adapter) {
+    const snapshot = await adapter.pull();
+    return {
+        snapshot,
+        rows: importTranslationWorkbook(snapshot.value),
+    };
+}
+export async function pushTranslationWorkbookToService(adapter, catalogs, locale, snapshot = {}) {
+    return adapter.push({
+        ...snapshot,
+        value: exportTranslationWorkbook(catalogs, locale),
+    });
+}
+export async function pullCatalogBundleFromService(adapter) {
+    const snapshot = await adapter.pull();
+    return {
+        snapshot,
+        catalogs: importCatalogBundle(snapshot.value),
+    };
+}
+export async function pushCatalogBundleToService(adapter, catalogs, snapshot = {}) {
+    return adapter.push({
+        ...snapshot,
+        value: exportCatalogBundle(catalogs),
+    });
+}
+//# sourceMappingURL=service.js.map

package/dist/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AA0B/H,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACtD,OAAuC;IAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IACtC,OAAO;QACL,QAAQ;QACR,IAAI,EAAE,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC;KAChD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gCAAgC,CACpD,OAAuC,EACvC,QAAqC,EACrC,MAAc,EACd,WAAqE,EAAE;IAEvE,OAAO,OAAO,CAAC,IAAI,CAAC;QAClB,GAAG,QAAQ;QACX,KAAK,EAAE,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC;KACnD,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,OAAoC;IAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IACtC,OAAO;QACL,QAAQ;QACR,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC;KAC9C,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,OAAoC,EACpC,QAAqC,EACrC,WAAkE,EAAE;IAEpE,OAAO,OAAO,CAAC,IAAI,CAAC;QAClB,GAAG,QAAQ;QACX,KAAK,EAAE,mBAAmB,CAAC,QAAQ,CAAC;KACrC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyingrobots/bijou-i18n-tools",
-  "version": "4.4.1",
+  "version": "5.0.0",
   "description": "Localization workflow tooling for Bijou — authoring catalogs, stale detection, tabular export/import, and runtime compilation.",
   "type": "module",
   "sideEffects": false,
@@ -24,7 +24,7 @@
     "lint": "tsc --noEmit"
   },
   "dependencies": {
-    "@flyingrobots/bijou-i18n": "4.4.1"
+    "@flyingrobots/bijou-i18n": "5.0.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",