@milaboratories/pl-model-middle-layer 1.2.20 → 1.3.0

package/src/block_meta/block_manifest.ts

@@ -0,0 +1,38 @@
+import { z } from 'zod';
+import { BlockComponents } from './block_components';
+import { ContentRelative, ContentRelativeBinary, ContentRelativeText } from './content_types';
+import { CreateBlockPackDescriptionSchema } from './block_description';
+import { BlockPackMeta } from './block_meta';
+
+export const BlockComponentsManifest = BlockComponents(ContentRelative, ContentRelative);
+export type BlockComponentsManifest = z.infer<typeof BlockComponentsManifest>;
+
+export const BlockPackMetaManifest = BlockPackMeta(ContentRelativeText, ContentRelativeBinary);
+export type BlockPackMetaManifest = z.infer<typeof BlockPackMetaManifest>;
+
+/** Block description to be used in block manifest */
+export const BlockPackDescriptionManifest = CreateBlockPackDescriptionSchema(
+  BlockComponentsManifest,
+  BlockPackMetaManifest
+);
+export type BlockPackDescriptionManifest = z.infer<typeof BlockPackDescriptionManifest>;
+
+export const ManifestFileInfo = z.object({
+  name: z.string(),
+  size: z.number().int(),
+  sha256: z
+    .string()
+    .regex(/[0-9a-fA-F]/)
+    .toUpperCase()
+    .length(64) // 256 / 4 (bits per hex register)
+});
+export type ManifestFileInfo = z.infer<typeof ManifestFileInfo>;
+
+export const BlockPackManifest = z.object({
+  schema: z.literal('v2'),
+  description: BlockPackDescriptionManifest,
+  files: z.array(ManifestFileInfo)
+});
+export type BlockPackManifest = z.infer<typeof BlockPackManifest>;
+
+export const BlockPackManifestFile = 'manifest.json';

package/src/block_meta/{meta.ts → block_meta.ts}

@@ -1,12 +1,6 @@
 import { z } from 'zod';
 import {
-  ContentAbsoluteBinaryLocal,
-  ContentAbsoluteTextLocal,
   ContentExplicitBase64,
-  ContentExplicitString,
-  ContentRelative,
-  ContentRelativeBinary,
-  ContentRelativeText,
   DescriptionContentBinary,
   DescriptionContentText
 } from './content_types';
@@ -39,13 +33,6 @@ export const BlockPackMetaDescriptionRaw = BlockPackMeta(
 );
 export type BlockPackMetaDescriptionRaw = z.infer<typeof BlockPackMetaDescriptionRaw>;
 
-// prettier-ignore
-export const BlockPackMetaManifest = BlockPackMeta(
-  ContentRelativeText,
-  ContentRelativeBinary
-);
-export type BlockPackMetaManifest = z.infer<typeof BlockPackMetaManifest>;
-
 // prettier-ignore
 export const BlockPackMetaEmbeddedContent = BlockPackMeta(
   z.string(),

package/src/block_meta/content_conversion.ts

@@ -1,13 +1,33 @@
-import { ContentAbsoluteUrl, ContentAnyLocal, ContentRelative } from "./content_types";
+import {
+  ContentAbsoluteUrl,
+  ContentAnyLocal,
+  ContentExplicitOrRelative,
+  ContentRelative
+} from './content_types';
 
 export function mapRemoteToAbsolute(
   rootUrl: string
-): <T extends ContentAnyLocal>(
-  value: T
-) => Exclude<T, ContentRelative> | ContentAbsoluteUrl {
+): <T extends ContentAnyLocal>(value: T) => Exclude<T, ContentRelative> | ContentAbsoluteUrl {
   const rootWithSlash = rootUrl.endsWith('/') ? rootUrl : `${rootUrl}/`;
   return <T extends ContentAnyLocal>(value: T) =>
     value.type === 'relative'
       ? { type: 'absolute-url', url: rootWithSlash + value.path }
       : (value as Exclude<T, ContentRelative>);
 }
+
+/**
+ * Creates transformer of relative content paths, that adds a specific prefix to the relative path.
+ *
+ * If prefix = "nested-path/", paths like "somefile.txt" will be transformed to "nested-path/somefile.txt".
+ *
+ * @param prefix prefix to add to the relaive path, slesh at the end will be added automatically if missed
+ */
+export function addPrefixToRelative(
+  prefix: string
+): <T extends ContentExplicitOrRelative>(value: T) => T {
+  const prefixWithSlash = prefix.endsWith('/') ? prefix : `${prefix}/`;
+  return <T extends ContentExplicitOrRelative>(value: T) =>
+    (value.type === 'relative'
+      ? { type: 'relative', path: prefixWithSlash + value.path }
+      : value) as T;
+}

package/src/block_meta/content_types.ts

@@ -56,13 +56,17 @@ export type ContentAbsoluteUrl = z.infer<typeof ContentAbsoluteUrl>;
 // Special content types
 //
 
-export const ContentExplicit = z
+export const ContentExplicitBytes = z
   .object({
-    type: z.literal('explicit'),
+    type: z.literal('explicit-bytes'),
+    mimeType: z
+      .string()
+      .regex(/\w+\/[-+.\w]+/)
+      .describe('MIME type to interpret content'),
     content: z.instanceof(Uint8Array).describe('Raw content')
   })
   .strict();
-export type ContentExplicit = z.infer<typeof ContentExplicit>;
+export type ContentExplicitBytes = z.infer<typeof ContentExplicitBytes>;
 
 export const ContentAbsoluteFolder = z
   .object({
@@ -88,6 +92,13 @@ export const ContentAny = z.discriminatedUnion('type', [
 ]);
 export type ContentAny = z.infer<typeof ContentAny>;
 
+export const ContentExplicitOrRelative = z.discriminatedUnion('type', [
+  ContentExplicitString,
+  ContentExplicitBase64,
+  ContentRelative
+]);
+export type ContentExplicitOrRelative = z.infer<typeof ContentExplicitOrRelative>;
+
 export const ContentAnyLocal = z.discriminatedUnion('type', [
   ContentExplicitString,
   ContentExplicitBase64,

package/src/block_meta/index.ts

@@ -1,57 +1,11 @@
-import { ZodTypeAny, string, z } from 'zod';
-import { BlockComponentsDescriptionRaw, BlockComponentsManifest } from './block_components';
-import { BlockPackId } from './block_pack_id';
-import { BlockPackMetaDescriptionRaw, BlockPackMetaManifest } from './meta';
-
-export * from './block_components';
-export * from './block_pack_id';
 export * from './common';
 export * from './content_types';
-export * from './meta';
 export * from './semver';
 
-export const BlockPackDescriptionFromPackageJsonRaw = z.object({
-  components: BlockComponentsDescriptionRaw,
-  meta: BlockPackMetaDescriptionRaw
-});
-
-export function CreateBlockPackDescriptionSchema<
-  Components extends ZodTypeAny,
-  Meta extends ZodTypeAny
->(components: Components, meta: Meta) {
-  return z.object({
-    id: BlockPackId,
-    components,
-    meta
-  });
-}
-
-export const BlockPackDescriptionManifest = CreateBlockPackDescriptionSchema(
-  BlockComponentsManifest,
-  BlockPackMetaManifest
-);
-export type BlockPackDescriptionManifest = z.infer<typeof BlockPackDescriptionManifest>;
+export * from './content_conversion';
 
-export const BlockPackDescriptionRaw = CreateBlockPackDescriptionSchema(
-  BlockComponentsDescriptionRaw,
-  BlockPackMetaDescriptionRaw
-);
-export type BlockPackDescriptionRaw = z.infer<typeof BlockPackDescriptionRaw>;
-
-export const ManifestFileInfo = z.object({
-  name: z.string(),
-  size: z.number().int(),
-  sha256: z
-    .string()
-    .regex(/[0-9a-fA-F]/)
-    .toUpperCase()
-    .length(64) // 256 / 4 (bits per hex register)
-});
-export type ManifestFileInfo = z.infer<typeof ManifestFileInfo>;
-
-export const BlockPackManifest = z.object({
-  schema: z.literal('v1'),
-  description: BlockPackDescriptionManifest,
-  files: z.array(ManifestFileInfo)
-});
-export type BlockPackManifest = z.infer<typeof BlockPackManifest>;
+export * from './block_id';
+export * from './block_components';
+export * from './block_meta';
+export * from './block_description';
+export * from './block_manifest';

package/dist/block_meta/block_pack_id.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"block_pack_id.d.ts","sourceRoot":"","sources":["../../src/block_meta/block_pack_id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,qCAAqC;AACrC,eAAO,MAAM,WAAW;;;;;;;;;;;;EAMb,CAAC;AACZ,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,eAAO,MAAM,oBAAoB;;;;;;;;;;EAAsC,CAAC;AACxE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/block_meta/meta.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../src/block_meta/meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB,wBAAgB,aAAa,CAC3B,KAAK,CAAC,cAAc,SAAS,CAAC,CAAC,UAAU,EACzC,KAAK,CAAC,UAAU,SAAS,CAAC,CAAC,UAAU,EACrC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAgB/C;AAGD,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGvC,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAGtF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAG1E,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGxC,CAAC;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}