@milaboratories/pl-model-common 1.13.8 → 1.14.0

package/dist/ref.d.ts

@@ -3,14 +3,17 @@ export declare const PlRef: z.ZodReadonly<z.ZodObject<{
     __isRef: z.ZodLiteral<true>;
     blockId: z.ZodString;
     name: z.ZodString;
-}, "strict", z.ZodTypeAny, {
+    requireEnrichments: z.ZodOptional<z.ZodLiteral<true>>;
+}, "strip", z.ZodTypeAny, {
     __isRef: true;
     blockId: string;
     name: string;
+    requireEnrichments?: true | undefined;
 }, {
     __isRef: true;
     blockId: string;
     name: string;
+    requireEnrichments?: true | undefined;
 }>>;
 export type PlRef = z.infer<typeof PlRef>;
 /** @deprecated use {@link PlRef} */
@@ -31,6 +34,34 @@ export type Option = {
     /** Label to be present for the user in i.e. drop-down list */
     readonly label: string;
 };
+/**
+ * Creates a PlRef with the given blockId and name.
+ *
+ * @param blockId - The blockId of the reference.
+ * @param name - The name of the reference.
+ * @param requireEnrichments - Whether the reference requires enrichments.
+ */
+export declare function createPlRef(blockId: string, name: string, requireEnrichments?: boolean): {
+    __isRef: boolean;
+    blockId: string;
+    name: string;
+    requireEnrichments: boolean;
+} | {
+    __isRef: boolean;
+    blockId: string;
+    name: string;
+    requireEnrichments?: undefined;
+};
+/**
+ * Creates a new PlRef based on an existing one, explicitly setting (default) or removing the
+ * requireEnrichments property.
+ *
+ * @param ref - The original PlRef object.
+ * @param requireEnrichments - If true, the `requireEnrichments: true` property is added
+ *   to the returned PlRef. If false, the `requireEnrichments` property is removed. Defaults to true.
+ * @returns A new PlRef object with the `requireEnrichments` property set or removed accordingly.
+ */
+export declare function withEnrichments(ref: PlRef, requireEnrichments?: boolean): PlRef;
 /** Compare two PlRefs and returns true if they are qual */
-export declare function plRefsEqual(ref1: PlRef, ref2: PlRef): boolean;
+export declare function plRefsEqual(ref1: PlRef, ref2: PlRef, ignoreEnrichments?: boolean): boolean;
 //# sourceMappingURL=ref.d.ts.map

package/dist/ref.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ref.d.ts","sourceRoot":"","sources":["../src/ref.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,KAAK;;;;;;;;;;;;GAcL,CAAC;AACd,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAC1C,oCAAoC;AACpC,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC;AAExB;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,CAStD;AAED;qCACqC;AACrC,MAAM,MAAM,MAAM,GAAG;IACnB;cACU;IACV,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;IAEpB,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,2DAA2D;AAC3D,wBAAgB,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,WAEnD"}
+{"version":3,"file":"ref.d.ts","sourceRoot":"","sources":["../src/ref.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;GAkBL,CAAC;AACd,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAC1C,oCAAoC;AACpC,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC;AAExB;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,CAStD;AAED;qCACqC;AACrC,MAAM,MAAM,MAAM,GAAG;IACnB;cACU;IACV,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;IAEpB,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,GAAE,OAAe;;;;;;;;;;EAc7F;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,kBAAkB,GAAE,OAAc,GAAG,KAAK,CAUrF;AAED,2DAA2D;AAC3D,wBAAgB,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,iBAAiB,GAAE,OAAe,WAEvF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-model-common",
-  "version": "1.13.8",
+  "version": "1.14.0",
   "description": "Platforma SDK Model",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",

package/src/ref.ts

@@ -5,15 +5,19 @@ export const PlRef = z
     __isRef: z
       .literal(true)
       .describe('Crucial marker for the block dependency tree reconstruction'),
-    blockId: z.string().describe('Upstream block id'),
-    name: z.string().describe('Name of the output provided to the upstream block\'s output context'),
+    blockId: z.string()
+      .describe('Upstream block id'),
+    name: z.string()
+      .describe('Name of the output provided to the upstream block\'s output context'),
+    requireEnrichments: z.literal(true).optional()
+      .describe('True if current block that stores this reference in its args, may need enrichments '
+        + 'for the references value originating from the blocks in between current and referenced block'),
   })
   .describe(
     'Universal reference type, allowing to set block connections. It is crucial that '
     + '{@link __isRef} is present and equal to true, internal logic relies on this marker '
     + 'to build block dependency trees.',
   )
-  .strict()
   .readonly();
 export type PlRef = z.infer<typeof PlRef>;
 /** @deprecated use {@link PlRef} */
@@ -47,7 +51,51 @@ export type Option = {
   readonly label: string;
 };
 
+/**
+ * Creates a PlRef with the given blockId and name.
+ *
+ * @param blockId - The blockId of the reference.
+ * @param name - The name of the reference.
+ * @param requireEnrichments - Whether the reference requires enrichments.
+ */
+export function createPlRef(blockId: string, name: string, requireEnrichments: boolean = false) {
+  if (requireEnrichments)
+    return {
+      __isRef: true,
+      blockId,
+      name,
+      requireEnrichments: true,
+    };
+  else
+    return {
+      __isRef: true,
+      blockId,
+      name,
+    };
+}
+
+/**
+ * Creates a new PlRef based on an existing one, explicitly setting (default) or removing the
+ * requireEnrichments property.
+ *
+ * @param ref - The original PlRef object.
+ * @param requireEnrichments - If true, the `requireEnrichments: true` property is added
+ *   to the returned PlRef. If false, the `requireEnrichments` property is removed. Defaults to true.
+ * @returns A new PlRef object with the `requireEnrichments` property set or removed accordingly.
+ */
+export function withEnrichments(ref: PlRef, requireEnrichments: boolean = true): PlRef {
+  if (requireEnrichments)
+    return {
+      ...ref,
+      requireEnrichments: true,
+    };
+  else {
+    const { requireEnrichments: _, ...rest } = ref;
+    return rest;
+  }
+}
+
 /** Compare two PlRefs and returns true if they are qual */
-export function plRefsEqual(ref1: PlRef, ref2: PlRef) {
-  return ref1.blockId === ref2.blockId && ref1.name === ref2.name;
+export function plRefsEqual(ref1: PlRef, ref2: PlRef, ignoreEnrichments: boolean = false) {
+  return ref1.blockId === ref2.blockId && ref1.name === ref2.name && (ignoreEnrichments || ref1.requireEnrichments === ref2.requireEnrichments);
 }