@paroicms/public-server-lib 1.0.2 → 1.1.0

package/dist/load-descriptors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"load-descriptors.d.ts","sourceRoot":"","sources":["../src/load-descriptors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EAC1B,MAAM,mCAAmC,CAAC;AAI3C,MAAM,WAAW,kBAAkB;IACjC,oBAAoB,EAAE,qBAAqB,CAAC;CAC7C;AAED,MAAM,WAAW,6BAA6B;IAC5C,oBAAoB,EAAE,6BAA6B,CAAC;CACrD;AAED,MAAM,WAAW,2BAA2B;IAC1C,oBAAoB,EAAE,0BAA0B,CAAC;CAClD;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,GAAG,EAAE,CAAC,EACN,cAAc,EAAE,yBAAyB,GACxC,CAAC,GAAG,6BAA6B,CAAC;AACrC,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,GAAG,EAAE,CAAC,EACN,cAAc,EAAE,uBAAuB,GACtC,CAAC,GAAG,2BAA2B,CAAC;AACnC,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,GAAG,EAAE,CAAC,EACN,cAAc,EAAE,cAAc,GAC7B,CAAC,GAAG,kBAAkB,CAAC;AAM1B,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,GAAG,SAAS,CAK9E;AAED,wBAAgB,gCAAgC,CAC9C,GAAG,EAAE,OAAO,GACX,yBAAyB,GAAG,SAAS,CAIvC;AAED,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,OAAO,GAAG,uBAAuB,GAAG,SAAS,CAIhG;AAED,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,kBAAkB,EAC9D,IAAI,EAAE,CAAC,EACP,SAAS,EAAE,kBAAkB,GAC5B,CAAC,CAeH"}
+{"version":3,"file":"load-descriptors.d.ts","sourceRoot":"","sources":["../src/load-descriptors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EAC1B,MAAM,mCAAmC,CAAC;AAI3C,MAAM,WAAW,kBAAkB;IACjC,oBAAoB,EAAE,qBAAqB,CAAC;CAC7C;AAED,MAAM,WAAW,6BAA6B;IAC5C,oBAAoB,EAAE,6BAA6B,CAAC;CACrD;AAED,MAAM,WAAW,2BAA2B;IAC1C,oBAAoB,EAAE,0BAA0B,CAAC;CAClD;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,GAAG,EAAE,CAAC,EACN,cAAc,EAAE,yBAAyB,GACxC,CAAC,GAAG,6BAA6B,CAAC;AACrC,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,GAAG,EAAE,CAAC,EACN,cAAc,EAAE,uBAAuB,GACtC,CAAC,GAAG,2BAA2B,CAAC;AACnC,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,GAAG,EAAE,CAAC,EACN,cAAc,EAAE,cAAc,GAC7B,CAAC,GAAG,kBAAkB,CAAC;AAM1B,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,GAAG,SAAS,CAK9E;AAED,wBAAgB,gCAAgC,CAC9C,GAAG,EAAE,OAAO,GACX,yBAAyB,GAAG,SAAS,CAIvC;AAED,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,OAAO,GAAG,uBAAuB,GAAG,SAAS,CAIhG;AAED,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,kBAAkB,EAC9D,IAAI,EAAE,CAAC,EACP,SAAS,EAAE,kBAAkB,GAC5B,CAAC,CAkBH"}

package/dist/load-descriptors.js

@@ -28,6 +28,9 @@ export function mergeListDescriptor(base, newValues) {
     if (newValues.labeledWith) {
         target.labeledWith = newValues.labeledWith;
     }
+    if (newValues.fieldEquals) {
+        target.fieldEquals = newValues.fieldEquals;
+    }
     if (newValues.sorting) {
         target.sorting = newValues.sorting;
     }

package/dist/load-descriptors.js.map

@@ -1 +1 @@
-{"version":3,"file":"load-descriptors.js","sourceRoot":"","sources":["../src/load-descriptors.ts"],"names":[],"mappings":"AAOA,MAAM,oBAAoB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AA0BtD,MAAM,UAAU,oBAAoB,CAAC,GAAQ,EAAE,cAA8B;IAC3E,GAAG,CAAC,oBAAoB,CAAC,GAAG,cAAc,CAAC;IAC3C,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAY;IAChD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO;IACpD,IAAI,CAAC,CAAC,oBAAoB,IAAI,GAAG,CAAC;QAAE,OAAO;IAC3C,MAAM,OAAO,GAAG,GAAG,CAAC,oBAAoB,CAAmB,CAAC;IAC5D,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,gCAAgC,CAC9C,GAAY;IAEZ,MAAM,OAAO,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAO;IACrB,OAAO,OAAO,CAAC,IAAI,KAAK,KAAK,IAAI,OAAO,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AACzF,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,GAAY;IACzD,MAAM,OAAO,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAO;IACrB,OAAO,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1F,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,IAAO,EACP,SAA6B;IAE7B,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAC3B,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1B,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;IAC7C,CAAC;IACD,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;QACtB,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;IACrC,CAAC;IACD,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;IACnC,CAAC;IACD,IAAI,SAAS,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"load-descriptors.js","sourceRoot":"","sources":["../src/load-descriptors.ts"],"names":[],"mappings":"AAOA,MAAM,oBAAoB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AA0BtD,MAAM,UAAU,oBAAoB,CAAC,GAAQ,EAAE,cAA8B;IAC3E,GAAG,CAAC,oBAAoB,CAAC,GAAG,cAAc,CAAC;IAC3C,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAY;IAChD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO;IACpD,IAAI,CAAC,CAAC,oBAAoB,IAAI,GAAG,CAAC;QAAE,OAAO;IAC3C,MAAM,OAAO,GAAG,GAAG,CAAC,oBAAoB,CAAmB,CAAC;IAC5D,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,gCAAgC,CAC9C,GAAY;IAEZ,MAAM,OAAO,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAO;IACrB,OAAO,OAAO,CAAC,IAAI,KAAK,KAAK,IAAI,OAAO,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AACzF,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,GAAY;IACzD,MAAM,OAAO,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAO;IACrB,OAAO,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1F,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,IAAO,EACP,SAA6B;IAE7B,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAC3B,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1B,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;IAC7C,CAAC;IACD,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1B,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;IAC7C,CAAC;IACD,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;QACtB,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;IACrC,CAAC;IACD,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;IACnC,CAAC;IACD,IAAI,SAAS,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {

package/types/backend-plugin-types.d.ts

@@ -113,6 +113,10 @@ export interface BackendPluginInitService extends PluginStaticConfiguration {
       UpdateFieldValue
     >,
   ): void;
+  registerHook(
+    hookName: "afterSaveValues",
+    handler: BackendHookHandler<undefined, AfterSaveValuesInfo, void>,
+  ): void;
   registerHook(hookName: "sendMail", handler: BackendHookHandler<MailData, undefined, void>): void;
   registerHook(
     hookName: "markdownToNative",
@@ -136,6 +140,24 @@ export type BackendHookHandler<V = unknown, O = unknown, R = unknown> = (hookPay
   options: O;
 }) => Promise<R> | R;
 
+export interface AfterSaveValuesInfo {
+  nodeKind: "document" | "part" | "site";
+  /** Absent for `"site"`. For a part, this is the partId. */
+  lNodeId?: string;
+  /** Absent for `"site"`. */
+  nodeId?: string;
+  /** `"_site"` for site saves. */
+  typeName: string;
+  language?: string;
+  changes: SavedFieldChange[];
+}
+
+export interface SavedFieldChange {
+  fieldName: string;
+  oldValue: ReadFieldValue | undefined;
+  newValue: ReadFieldValue | undefined;
+}
+
 export type RenderingHookHandler<V extends ReadFieldValue = ReadFieldValue> = (hookPayload: {
   service: PluginRenderingService;
   value: V;
@@ -263,10 +285,13 @@ export interface PluginRenderingService {
   homeUrl: string;
   setRenderState(key: string, value: any): void;
 
-  loadDocuments(loadDescriptor: DocumentsLoadDescriptor): Promise<LiquidPayload<TpDocPayload>[]>;
   loadDocuments(
     loadDescriptor: DocumentsLoadDescriptor,
-    options: { withTotal: true },
+    options?: { onlyPublished?: boolean },
+  ): Promise<LiquidPayload<TpDocPayload>[]>;
+  loadDocuments(
+    loadDescriptor: DocumentsLoadDescriptor,
+    options: { withTotal: true; onlyPublished?: boolean },
   ): Promise<{ documents: LiquidPayload<TpDocPayload>[]; total: number }>;
 
   renderDocument(templateName: string, doc: LiquidPayload<TpDocPayload>): Promise<string>;
@@ -403,6 +428,8 @@ export interface RunningSiteConnector {
   createPart(input: CreatePartInput): Promise<MinimalPartInfo>;
   createPartTranslation(input: CreatePartTranslationInput): Promise<MinimalPartInfo>;
   setMedia(input: SetMediaInput): Promise<MSourceMedia>;
+  /** Returns the deleted media ids. */
+  deleteMedia(input: { handle: string; mediaId?: string }): Promise<string[]>;
 }
 
 export interface MinimalDocumentInfo {
@@ -484,6 +511,11 @@ export interface CreateDocumentInput {
   typeName: string;
   title?: string;
   slug?: string;
+  /**
+   * Honored when the document type's route is `":relativeId"` (validated for format and sibling
+   * uniqueness); ignored otherwise.
+   */
+  relativeId?: string;
   values?: UpdateFieldValues;
 }
 

package/types/load-descriptor-types.d.ts

@@ -9,6 +9,7 @@ export interface ListBaseDescriptor {
   limit?: number;
   sorting?: ScSorting;
   labeledWith?: LabeledWithDescriptor;
+  fieldEquals?: FieldEqualsDescriptor;
 }
 
 export interface LabeledWithDescriptor {
@@ -16,6 +17,11 @@ export interface LabeledWithDescriptor {
   termNodeId: string;
 }
 
+export interface FieldEqualsDescriptor {
+  fieldName: string;
+  value: string;
+}
+
 export interface ChildDocumentsLoadDescriptor extends ListBaseDescriptor {
   load: "list";
   nodeKind: "document";