@revenexx/node 0.1.0 → 0.1.1

package/dist/services/pages-editor.d.mts

@@ -5,6 +5,15 @@ import '../query.mjs';
 import '../enums/address-type-row-tone.mjs';
 import '../enums/address-type-row-create-request-tone.mjs';
 import '../enums/address-type-row-update-request-tone.mjs';
+import '../enums/approval-rule-approver-type.mjs';
+import '../enums/approval-rule-condition.mjs';
+import '../enums/approval-rule-effect.mjs';
+import '../enums/approval-rule-create-request-approver-type.mjs';
+import '../enums/approval-rule-create-request-condition.mjs';
+import '../enums/approval-rule-create-request-effect.mjs';
+import '../enums/approval-rule-update-request-approver-type.mjs';
+import '../enums/approval-rule-update-request-condition.mjs';
+import '../enums/approval-rule-update-request-effect.mjs';
 import '../enums/assets-source.mjs';
 import '../enums/attribute-value-bucket.mjs';
 import '../enums/auth-mail-source.mjs';
@@ -118,6 +127,8 @@ import '../enums/payment-term-tone.mjs';
 import '../enums/payment-term-create-request-tone.mjs';
 import '../enums/payment-term-update-request-tone.mjs';
 import '../enums/payment-vocabulary-tone.mjs';
+import '../enums/pending-approval-approver-type.mjs';
+import '../enums/pending-approval-status.mjs';
 import '../enums/price-ending-rule.mjs';
 import '../enums/price-entries-adjust-response-rounding.mjs';
 import '../enums/price-entries-adjust-response-rounding-mode.mjs';
@@ -140,6 +151,11 @@ import '../enums/product-grid-column-source.mjs';
 import '../enums/product-label-source.mjs';
 import '../enums/product-label-attribute-source.mjs';
 import '../enums/products-kind.mjs';
+import '../enums/purchase-request-status.mjs';
+import '../enums/purchase-request-event-name.mjs';
+import '../enums/purchase-request-item-type.mjs';
+import '../enums/purchase-request-item-create-request-type.mjs';
+import '../enums/purchase-request-item-update-request-type.mjs';
 import '../enums/reorder-point-source.mjs';
 import '../enums/reservation-status.mjs';
 import '../enums/price-on-request-reason.mjs';
@@ -177,6 +193,8 @@ import '../enums/shipping-weight-unit-row-tone.mjs';
 import '../enums/shipping-weight-unit-update-request-tone.mjs';
 import '../enums/stock-movement-type.mjs';
 import '../enums/store-asset-request-visibility.mjs';
+import '../enums/submit-item-type.mjs';
+import '../enums/submit-result-outcome.mjs';
 import '../enums/validation-failed-response-status.mjs';
 import '../enums/vocabulary-default-tone.mjs';
 import '../enums/vocabulary-source.mjs';
@@ -257,20 +275,20 @@ declare class PagesEditor {
      *
      * @param {object[]} params.items - The strings to translate. This app reads no element of the list — the provider defines the contract, and the blökkli adapter sends the fields below.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      */
     pagesEditorTranslate(params?: {
         items?: object[];
-    }): Promise<Models.Error>;
+    }): Promise<{}>;
     /**
      * The translation is the tenant's provider's, not this app's, and a tenant that has configured none gets no translation at all. The endpoint comes from the tenant setting `translate_endpoint` (PAGES_TRANSLATE_ENDPOINT remains a fallback). The bearer token does NOT: the gateway masks every setting flagged `sensitive`, so a key stored as one could never be read back — it stays the PAGES_TRANSLATE_KEY function secret. This app does not translate anything itself; it forwards `items` and hands the answer back.
      *
      * @param {object[]} items - The strings to translate. This app reads no element of the list — the provider defines the contract, and the blökkli adapter sends the fields below.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorTranslate(items?: object[]): Promise<Models.Error>;
+    pagesEditorTranslate(items?: object[]): Promise<{}>;
     /**
      * Per-user editor preferences — one row per user, scoped to this app. Not tenant configuration: nothing here changes what the API does, only how one person's editor looks.
      *
@@ -426,13 +444,13 @@ declare class PagesEditor {
      * @param {boolean} params.force - Publish despite violations. Without it a page with unresolved violations answers 422 and nothing is written.
      * @param {string} params.label - What to call this publication in the page's history — "Autumn campaign" rather than a timestamp.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.MutationResponse>}
      */
     pagesEditorPublish(params: {
         pageId: string;
         force?: boolean;
         label?: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.MutationResponse>;
     /**
      * Four things in one call: the mutation log is replayed into a finished block tree, that tree is snapshotted into a new revision, the page's canonical blocks are replaced by it, and the edit state is archived — so the page comes out of this with nothing unpublished and the working copy behind it closed rather than deleted. The revision is written FIRST and the canonical blocks replaced after, so a failure mid-way leaves the page recoverable. Block uuids survive, which is why comments anchored to a block outlive the publish.
      *
@@ -440,10 +458,10 @@ declare class PagesEditor {
      * @param {boolean} force - Publish despite violations. Without it a page with unresolved violations answers 422 and nothing is written.
      * @param {string} label - What to call this publication in the page's history — "Autumn campaign" rather than a timestamp.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.MutationResponse>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorPublish(pageId: string, force?: boolean, label?: string): Promise<Models.Error>;
+    pagesEditorPublish(pageId: string, force?: boolean, label?: string): Promise<Models.MutationResponse>;
     /**
      * Throws the whole working copy away: the edit state row is deleted and its mutation log with it, so the history goes too — this is not an undo and cannot itself be undone. Unlike publishing, which archives the edit state, nothing of it survives to be reopened. The published page is untouched.
      *
@@ -469,22 +487,22 @@ declare class PagesEditor {
      * @param {string} params.pageId - The page being edited.
      * @param {string} params.scheduledAt - The moment to publish at. Stored on the edit state and echoed back normalized to UTC.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      */
     pagesEditorSchedule(params: {
         pageId: string;
         scheduledAt: string;
-    }): Promise<Models.Error>;
+    }): Promise<{}>;
     /**
      * Gated on the tenant setting `enable_scheduled_publishing`, which is off by default: nothing in the platform publishes a scheduled edit state yet, so a date accepted here would be a promise the app cannot keep. Every editor state carries `features.scheduledPublishing` so the control can be hidden rather than the refusal discovered.
      *
      * @param {string} pageId - The page being edited.
      * @param {string} scheduledAt - The moment to publish at. Stored on the edit state and echoed back normalized to UTC.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorSchedule(pageId: string, scheduledAt: string): Promise<Models.Error>;
+    pagesEditorSchedule(pageId: string, scheduledAt: string): Promise<{}>;
     /**
      * The one call the visual editor boots on, and the only place the UNPUBLISHED page can be seen whole: the canonical blocks with every enabled mutation of the log replayed over them, the resulting field lists, the mutation history itself, who owns the edit state and where the undo pointer sits, and the tenant's editor feature flags. `langcode` decides which language the props resolve in, falling back to the page's source language. `index` replays the log up to a given position instead of the current one, which is how the editor previews an undo without performing it — it changes nothing, so it is safe to call at any position. Reading this creates nothing either: a page nobody has opened answers with a null `editState`, an empty history, and the published blocks as they stand.
      *
@@ -540,7 +558,7 @@ declare class PagesEditor {
      * @param {boolean} params.isDefault - Whether a new page of that type should start from this template.
      * @param {string} params.pageBundle - The page type this template should be offered on. Omit to take the current page's own type.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Template>}
      */
     pagesEditorTemplatesCreate(params: {
         pageId: string;
@@ -550,7 +568,7 @@ declare class PagesEditor {
         fieldName?: string;
         isDefault?: boolean;
         pageBundle?: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.Template>;
     /**
      * Freezes a selection into a reusable starting point. The blocks are read out of the page's CURRENT edit state rather than out of what is published, so a template can be cut from work in progress and the uuids you send are the ones the editor is showing. Unlike making a block reusable, this COPIES: pages later made from the template are independent of it and of each other.
      *
@@ -562,10 +580,10 @@ declare class PagesEditor {
      * @param {boolean} isDefault - Whether a new page of that type should start from this template.
      * @param {string} pageBundle - The page type this template should be offered on. Omit to take the current page's own type.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Template>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorTemplatesCreate(pageId: string, label: string, uuids: string[], description?: string, fieldName?: string, isDefault?: boolean, pageBundle?: string): Promise<Models.Error>;
+    pagesEditorTemplatesCreate(pageId: string, label: string, uuids: string[], description?: string, fieldName?: string, isDefault?: boolean, pageBundle?: string): Promise<Models.Template>;
     /**
      * Takes a parked edit state back to `active` and clears its date, so the scheduled publication simply does not happen. The work is not touched — the mutation log, the undo position and the owner all stay as they were — and the page can then be published by hand or scheduled again for a different date. Like every other write to an edit state it asks for ownership, and a page with no open edit state answers 404 rather than pretending to have cancelled something.
      *

package/dist/services/pages-editor.d.ts

@@ -5,6 +5,15 @@ import '../query.js';
 import '../enums/address-type-row-tone.js';
 import '../enums/address-type-row-create-request-tone.js';
 import '../enums/address-type-row-update-request-tone.js';
+import '../enums/approval-rule-approver-type.js';
+import '../enums/approval-rule-condition.js';
+import '../enums/approval-rule-effect.js';
+import '../enums/approval-rule-create-request-approver-type.js';
+import '../enums/approval-rule-create-request-condition.js';
+import '../enums/approval-rule-create-request-effect.js';
+import '../enums/approval-rule-update-request-approver-type.js';
+import '../enums/approval-rule-update-request-condition.js';
+import '../enums/approval-rule-update-request-effect.js';
 import '../enums/assets-source.js';
 import '../enums/attribute-value-bucket.js';
 import '../enums/auth-mail-source.js';
@@ -118,6 +127,8 @@ import '../enums/payment-term-tone.js';
 import '../enums/payment-term-create-request-tone.js';
 import '../enums/payment-term-update-request-tone.js';
 import '../enums/payment-vocabulary-tone.js';
+import '../enums/pending-approval-approver-type.js';
+import '../enums/pending-approval-status.js';
 import '../enums/price-ending-rule.js';
 import '../enums/price-entries-adjust-response-rounding.js';
 import '../enums/price-entries-adjust-response-rounding-mode.js';
@@ -140,6 +151,11 @@ import '../enums/product-grid-column-source.js';
 import '../enums/product-label-source.js';
 import '../enums/product-label-attribute-source.js';
 import '../enums/products-kind.js';
+import '../enums/purchase-request-status.js';
+import '../enums/purchase-request-event-name.js';
+import '../enums/purchase-request-item-type.js';
+import '../enums/purchase-request-item-create-request-type.js';
+import '../enums/purchase-request-item-update-request-type.js';
 import '../enums/reorder-point-source.js';
 import '../enums/reservation-status.js';
 import '../enums/price-on-request-reason.js';
@@ -177,6 +193,8 @@ import '../enums/shipping-weight-unit-row-tone.js';
 import '../enums/shipping-weight-unit-update-request-tone.js';
 import '../enums/stock-movement-type.js';
 import '../enums/store-asset-request-visibility.js';
+import '../enums/submit-item-type.js';
+import '../enums/submit-result-outcome.js';
 import '../enums/validation-failed-response-status.js';
 import '../enums/vocabulary-default-tone.js';
 import '../enums/vocabulary-source.js';
@@ -257,20 +275,20 @@ declare class PagesEditor {
      *
      * @param {object[]} params.items - The strings to translate. This app reads no element of the list — the provider defines the contract, and the blökkli adapter sends the fields below.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      */
     pagesEditorTranslate(params?: {
         items?: object[];
-    }): Promise<Models.Error>;
+    }): Promise<{}>;
     /**
      * The translation is the tenant's provider's, not this app's, and a tenant that has configured none gets no translation at all. The endpoint comes from the tenant setting `translate_endpoint` (PAGES_TRANSLATE_ENDPOINT remains a fallback). The bearer token does NOT: the gateway masks every setting flagged `sensitive`, so a key stored as one could never be read back — it stays the PAGES_TRANSLATE_KEY function secret. This app does not translate anything itself; it forwards `items` and hands the answer back.
      *
      * @param {object[]} items - The strings to translate. This app reads no element of the list — the provider defines the contract, and the blökkli adapter sends the fields below.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorTranslate(items?: object[]): Promise<Models.Error>;
+    pagesEditorTranslate(items?: object[]): Promise<{}>;
     /**
      * Per-user editor preferences — one row per user, scoped to this app. Not tenant configuration: nothing here changes what the API does, only how one person's editor looks.
      *
@@ -426,13 +444,13 @@ declare class PagesEditor {
      * @param {boolean} params.force - Publish despite violations. Without it a page with unresolved violations answers 422 and nothing is written.
      * @param {string} params.label - What to call this publication in the page's history — "Autumn campaign" rather than a timestamp.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.MutationResponse>}
      */
     pagesEditorPublish(params: {
         pageId: string;
         force?: boolean;
         label?: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.MutationResponse>;
     /**
      * Four things in one call: the mutation log is replayed into a finished block tree, that tree is snapshotted into a new revision, the page's canonical blocks are replaced by it, and the edit state is archived — so the page comes out of this with nothing unpublished and the working copy behind it closed rather than deleted. The revision is written FIRST and the canonical blocks replaced after, so a failure mid-way leaves the page recoverable. Block uuids survive, which is why comments anchored to a block outlive the publish.
      *
@@ -440,10 +458,10 @@ declare class PagesEditor {
      * @param {boolean} force - Publish despite violations. Without it a page with unresolved violations answers 422 and nothing is written.
      * @param {string} label - What to call this publication in the page's history — "Autumn campaign" rather than a timestamp.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.MutationResponse>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorPublish(pageId: string, force?: boolean, label?: string): Promise<Models.Error>;
+    pagesEditorPublish(pageId: string, force?: boolean, label?: string): Promise<Models.MutationResponse>;
     /**
      * Throws the whole working copy away: the edit state row is deleted and its mutation log with it, so the history goes too — this is not an undo and cannot itself be undone. Unlike publishing, which archives the edit state, nothing of it survives to be reopened. The published page is untouched.
      *
@@ -469,22 +487,22 @@ declare class PagesEditor {
      * @param {string} params.pageId - The page being edited.
      * @param {string} params.scheduledAt - The moment to publish at. Stored on the edit state and echoed back normalized to UTC.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      */
     pagesEditorSchedule(params: {
         pageId: string;
         scheduledAt: string;
-    }): Promise<Models.Error>;
+    }): Promise<{}>;
     /**
      * Gated on the tenant setting `enable_scheduled_publishing`, which is off by default: nothing in the platform publishes a scheduled edit state yet, so a date accepted here would be a promise the app cannot keep. Every editor state carries `features.scheduledPublishing` so the control can be hidden rather than the refusal discovered.
      *
      * @param {string} pageId - The page being edited.
      * @param {string} scheduledAt - The moment to publish at. Stored on the edit state and echoed back normalized to UTC.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorSchedule(pageId: string, scheduledAt: string): Promise<Models.Error>;
+    pagesEditorSchedule(pageId: string, scheduledAt: string): Promise<{}>;
     /**
      * The one call the visual editor boots on, and the only place the UNPUBLISHED page can be seen whole: the canonical blocks with every enabled mutation of the log replayed over them, the resulting field lists, the mutation history itself, who owns the edit state and where the undo pointer sits, and the tenant's editor feature flags. `langcode` decides which language the props resolve in, falling back to the page's source language. `index` replays the log up to a given position instead of the current one, which is how the editor previews an undo without performing it — it changes nothing, so it is safe to call at any position. Reading this creates nothing either: a page nobody has opened answers with a null `editState`, an empty history, and the published blocks as they stand.
      *
@@ -540,7 +558,7 @@ declare class PagesEditor {
      * @param {boolean} params.isDefault - Whether a new page of that type should start from this template.
      * @param {string} params.pageBundle - The page type this template should be offered on. Omit to take the current page's own type.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Template>}
      */
     pagesEditorTemplatesCreate(params: {
         pageId: string;
@@ -550,7 +568,7 @@ declare class PagesEditor {
         fieldName?: string;
         isDefault?: boolean;
         pageBundle?: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.Template>;
     /**
      * Freezes a selection into a reusable starting point. The blocks are read out of the page's CURRENT edit state rather than out of what is published, so a template can be cut from work in progress and the uuids you send are the ones the editor is showing. Unlike making a block reusable, this COPIES: pages later made from the template are independent of it and of each other.
      *
@@ -562,10 +580,10 @@ declare class PagesEditor {
      * @param {boolean} isDefault - Whether a new page of that type should start from this template.
      * @param {string} pageBundle - The page type this template should be offered on. Omit to take the current page's own type.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Template>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesEditorTemplatesCreate(pageId: string, label: string, uuids: string[], description?: string, fieldName?: string, isDefault?: boolean, pageBundle?: string): Promise<Models.Error>;
+    pagesEditorTemplatesCreate(pageId: string, label: string, uuids: string[], description?: string, fieldName?: string, isDefault?: boolean, pageBundle?: string): Promise<Models.Template>;
     /**
      * Takes a parked edit state back to `active` and clears its date, so the scheduled publication simply does not happen. The work is not touched — the mutation log, the undo position and the owner all stay as they were — and the page can then be published by hand or scheduled again for a different date. Like every other write to an edit state it asks for ownership, and a page with no open edit state answers 404 rather than pretending to have cancelled something.
      *