@platforma-sdk/block-tools 2.6.44 → 2.6.45

package/src/v2/registry/schema_public.ts

@@ -1,5 +1,4 @@
-import type {
-  BlockPackId } from '@milaboratories/pl-model-middle-layer';
+import type { BlockPackId } from "@milaboratories/pl-model-middle-layer";
 import {
   AnyChannel,
   BlockComponentsManifest,
@@ -11,19 +10,19 @@ import {
   CreateBlockPackDescriptionSchema,
   Sha256Schema,
   VersionWithChannels,
-} from '@milaboratories/pl-model-middle-layer';
-import { z } from 'zod';
-import type { RelativeContentReader } from '../model';
-import { relativeToExplicitBytes, relativeToExplicitString } from '../model';
+} from "@milaboratories/pl-model-middle-layer";
+import { z } from "zod";
+import type { RelativeContentReader } from "../model";
+import { relativeToExplicitBytes, relativeToExplicitString } from "../model";
 
-export const MainPrefix = 'v2/';
+export const MainPrefix = "v2/";
 
-export const GlobalOverviewFileName = 'overview.json';
-export const GlobalOverviewGzFileName = 'overview.json.gz';
-export const PackageOverviewFileName = 'overview.json';
-export const ManifestFileName = 'manifest.json';
+export const GlobalOverviewFileName = "overview.json";
+export const GlobalOverviewGzFileName = "overview.json.gz";
+export const PackageOverviewFileName = "overview.json";
+export const ManifestFileName = "manifest.json";
 
-export const ChannelsFolder = 'channels';
+export const ChannelsFolder = "channels";
 
 export const ChannelNameRegexp = /^[-a-z0-9]+$/;
 
@@ -35,23 +34,27 @@ export function packageContentPrefix(bp: BlockPackId): string {
   return `${MainPrefix}${packageContentPrefixInsideV2(bp)}`;
 }
 
-export const ManifestSuffix = '/' + ManifestFileName;
+export const ManifestSuffix = "/" + ManifestFileName;
 
 // export function payloadFilePath(bp: BlockPackId, file: string): string {
 //   return `${MainPrefix}${bp.organization}/${bp.name}/${bp.version}/${file}`;
 // }
 
-export const PackageOverviewVersionEntry = z.object({
-  description: BlockPackDescriptionManifest,
-  channels: z.array(z.string()).default(() => []),
-  manifestSha256: Sha256Schema,
-}).passthrough();
+export const PackageOverviewVersionEntry = z
+  .object({
+    description: BlockPackDescriptionManifest,
+    channels: z.array(z.string()).default(() => []),
+    manifestSha256: Sha256Schema,
+  })
+  .passthrough();
 export type PackageOverviewVersionEntry = z.infer<typeof PackageOverviewVersionEntry>;
 
-export const PackageOverview = z.object({
-  schema: z.literal('v2'),
-  versions: z.array(PackageOverviewVersionEntry),
-}).passthrough();
+export const PackageOverview = z
+  .object({
+    schema: z.literal("v2"),
+    versions: z.array(PackageOverviewVersionEntry),
+  })
+  .passthrough();
 export type PackageOverview = z.infer<typeof PackageOverview>;
 
 export function packageOverviewPathInsideV2(bp: BlockPackIdNoVersion): string {
@@ -70,8 +73,8 @@ export function packageChannelPrefix(bp: BlockPackId): string {
   return `${MainPrefix}${packageChannelPrefixInsideV2(bp)}`;
 }
 
-export const PackageManifestPattern
-  = /(?<packageKeyWithoutVersion>(?<organization>[^/]+)\/(?<name>[^/]+))\/(?<version>[^/]+)\/manifest\.json$/;
+export const PackageManifestPattern =
+  /(?<packageKeyWithoutVersion>(?<organization>[^/]+)\/(?<name>[^/]+))\/(?<version>[^/]+)\/manifest\.json$/;
 
 export const GlobalOverviewPath = `${MainPrefix}${GlobalOverviewFileName}`;
 export const GlobalOverviewGzPath = `${MainPrefix}${GlobalOverviewGzFileName}`;
@@ -79,25 +82,29 @@ export const GlobalOverviewGzPath = `${MainPrefix}${GlobalOverviewGzFileName}`;
 export function GlobalOverviewEntry<const Description extends z.ZodTypeAny>(
   descriptionType: Description,
 ) {
-  const universalSchema = z.object({
-    id: BlockPackIdNoVersion,
-    /** @deprecated to be removed at some point, not used, left for compatibility with older versions */
-    allVersions: z.array(z.string()).optional(),
-    allVersionsWithChannels: z.array(VersionWithChannels).optional(),
-    /** @deprecated to be removed at some point, not used, left for compatibility with older versions */
-    latest: descriptionType,
-    /** @deprecated to be removed at some point, not used, left for compatibility with older versions */
-    latestManifestSha256: Sha256Schema,
-    latestByChannel: z
-      .record(
-        z.string(),
-        z.object({
-          description: descriptionType,
-          manifestSha256: Sha256Schema,
-        }).passthrough(),
-      )
-      .default({}),
-  }).passthrough();
+  const universalSchema = z
+    .object({
+      id: BlockPackIdNoVersion,
+      /** @deprecated to be removed at some point, not used, left for compatibility with older versions */
+      allVersions: z.array(z.string()).optional(),
+      allVersionsWithChannels: z.array(VersionWithChannels).optional(),
+      /** @deprecated to be removed at some point, not used, left for compatibility with older versions */
+      latest: descriptionType,
+      /** @deprecated to be removed at some point, not used, left for compatibility with older versions */
+      latestManifestSha256: Sha256Schema,
+      latestByChannel: z
+        .record(
+          z.string(),
+          z
+            .object({
+              description: descriptionType,
+              manifestSha256: Sha256Schema,
+            })
+            .passthrough(),
+        )
+        .default({}),
+    })
+    .passthrough();
   return (
     universalSchema
       .transform((o) => {
@@ -131,10 +138,12 @@ export type GlobalOverviewEntryReg = z.infer<typeof GlobalOverviewEntryReg>;
 export function GlobalOverview<const Description extends z.ZodTypeAny>(
   descriptionType: Description,
 ) {
-  return z.object({
-    schema: z.literal('v2'),
-    packages: z.array(GlobalOverviewEntry(descriptionType)),
-  }).passthrough();
+  return z
+    .object({
+      schema: z.literal("v2"),
+      packages: z.array(GlobalOverviewEntry(descriptionType)),
+    })
+    .passthrough();
 }
 
 export const GlobalOverviewReg = GlobalOverview(BlockPackDescriptionManifest);

package/src/v2/source_package.test.ts

@@ -1,28 +1,28 @@
-import { test, expect } from 'vitest';
-import { loadPackDescription, parsePackageName } from './source_package';
+import { test, expect } from "vitest";
+import { loadPackDescription, parsePackageName } from "./source_package";
 
-test('test parsing of convention package names', () => {
-  expect(parsePackageName('@milaboratory/milaboratories.block-template')).toStrictEqual({
-    organization: 'milaboratories',
-    name: 'block-template'
+test("test parsing of convention package names", () => {
+  expect(parsePackageName("@milaboratory/milaboratories.block-template")).toStrictEqual({
+    organization: "milaboratories",
+    name: "block-template",
   });
 
-  expect(parsePackageName('milaboratories.block-template')).toStrictEqual({
-    organization: 'milaboratories',
-    name: 'block-template'
+  expect(parsePackageName("milaboratories.block-template")).toStrictEqual({
+    organization: "milaboratories",
+    name: "block-template",
   });
 
-  expect(parsePackageName('mi-laboratories.block-template')).toStrictEqual({
-    organization: 'mi-laboratories',
-    name: 'block-template'
+  expect(parsePackageName("mi-laboratories.block-template")).toStrictEqual({
+    organization: "mi-laboratories",
+    name: "block-template",
   });
 
-  expect(() => parsePackageName('block-template')).toThrow(/Malformed/);
+  expect(() => parsePackageName("block-template")).toThrow(/Malformed/);
 });
 
-test.skip('full description parsing test', async () => {
+test.skip("full description parsing test", async () => {
   const description = await loadPackDescription(
-    '/Volumes/Data/Projects/MiLaboratory/blocks-beta/block-template'
+    "/Volumes/Data/Projects/MiLaboratory/blocks-beta/block-template",
   );
   console.dir(description, { depth: 5 });
 });

package/src/v2/source_package.ts

@@ -1,24 +1,22 @@
-import path from 'node:path';
-import { tryLoadFile } from '../util';
-import type { BlockPackDescriptionAbsolute } from './model';
-import { ResolvedBlockPackDescriptionFromPackageJson } from './model';
-import type { MiLogger } from '@milaboratories/ts-helpers';
-import { notEmpty } from '@milaboratories/ts-helpers';
-import fsp from 'node:fs/promises';
-import type {
-  BlockPackDescriptionRaw,
-  BlockPackId } from '@milaboratories/pl-model-middle-layer';
+import path from "node:path";
+import { tryLoadFile } from "../util";
+import type { BlockPackDescriptionAbsolute } from "./model";
+import { ResolvedBlockPackDescriptionFromPackageJson } from "./model";
+import type { MiLogger } from "@milaboratories/ts-helpers";
+import { notEmpty } from "@milaboratories/ts-helpers";
+import fsp from "node:fs/promises";
+import type { BlockPackDescriptionRaw, BlockPackId } from "@milaboratories/pl-model-middle-layer";
 import {
   BlockPackDescriptionFromPackageJsonRaw,
   SemVer,
-} from '@milaboratories/pl-model-middle-layer';
+} from "@milaboratories/pl-model-middle-layer";
 
-export const BlockDescriptionPackageJsonField = 'block';
+export const BlockDescriptionPackageJsonField = "block";
 
-const ConventionPackageNamePattern
-  = /(?:@[a-zA-Z0-9-.]+\/)?(?<organization>[a-zA-Z0-9-]+)\.(?<name>[a-zA-Z0-9-]+)/;
+const ConventionPackageNamePattern =
+  /(?:@[a-zA-Z0-9-.]+\/)?(?<organization>[a-zA-Z0-9-]+)\.(?<name>[a-zA-Z0-9-]+)/;
 
-export function parsePackageName(packageName: string): Pick<BlockPackId, 'organization' | 'name'> {
+export function parsePackageName(packageName: string): Pick<BlockPackId, "organization" | "name"> {
   const match = packageName.match(ConventionPackageNamePattern);
   if (!match)
     throw new Error(
@@ -32,10 +30,11 @@ export async function tryLoadPackDescription(
   moduleRoot: string,
   logger?: MiLogger,
 ): Promise<BlockPackDescriptionAbsolute | undefined> {
-  const fullPackageJsonPath = path.resolve(moduleRoot, 'package.json');
+  const fullPackageJsonPath = path.resolve(moduleRoot, "package.json");
   try {
-    const packageJson = await tryLoadFile(fullPackageJsonPath, (buf) =>
-      JSON.parse(buf.toString('utf-8')) as Record<string, unknown>,
+    const packageJson = await tryLoadFile(
+      fullPackageJsonPath,
+      (buf) => JSON.parse(buf.toString("utf-8")) as Record<string, unknown>,
     );
     if (packageJson === undefined) return undefined;
     const descriptionNotParsed = packageJson[BlockDescriptionPackageJsonField];
@@ -44,13 +43,16 @@ export async function tryLoadPackDescription(
       ...BlockPackDescriptionFromPackageJsonRaw.parse(descriptionNotParsed),
       id: {
         ...parsePackageName(
-          notEmpty(packageJson['name'] as string | undefined, `"name" not found in ${fullPackageJsonPath}`),
+          notEmpty(
+            packageJson["name"] as string | undefined,
+            `"name" not found in ${fullPackageJsonPath}`,
+          ),
         ),
-        version: SemVer.parse(packageJson['version']),
+        version: SemVer.parse(packageJson["version"]),
       },
     };
-    const descriptionParsingResult
-      = await ResolvedBlockPackDescriptionFromPackageJson(moduleRoot).safeParseAsync(descriptionRaw);
+    const descriptionParsingResult =
+      await ResolvedBlockPackDescriptionFromPackageJson(moduleRoot).safeParseAsync(descriptionRaw);
     if (descriptionParsingResult.success) return descriptionParsingResult.data;
     logger?.warn(descriptionParsingResult.error);
     return undefined;
@@ -61,8 +63,10 @@ export async function tryLoadPackDescription(
 }
 
 export async function loadPackDescriptionRaw(moduleRoot: string): Promise<BlockPackDescriptionRaw> {
-  const fullPackageJsonPath = path.resolve(moduleRoot, 'package.json');
-  const packageJson = JSON.parse(await fsp.readFile(fullPackageJsonPath, { encoding: 'utf-8' })) as Record<string, unknown>;
+  const fullPackageJsonPath = path.resolve(moduleRoot, "package.json");
+  const packageJson = JSON.parse(
+    await fsp.readFile(fullPackageJsonPath, { encoding: "utf-8" }),
+  ) as Record<string, unknown>;
   const descriptionNotParsed = packageJson[BlockDescriptionPackageJsonField];
   if (descriptionNotParsed === undefined)
     throw new Error(
@@ -72,9 +76,12 @@ export async function loadPackDescriptionRaw(moduleRoot: string): Promise<BlockP
     ...BlockPackDescriptionFromPackageJsonRaw.parse(descriptionNotParsed),
     id: {
       ...parsePackageName(
-        notEmpty(packageJson['name'] as string | undefined, `"name" not found in ${fullPackageJsonPath}`),
+        notEmpty(
+          packageJson["name"] as string | undefined,
+          `"name" not found in ${fullPackageJsonPath}`,
+        ),
       ),
-      version: SemVer.parse(packageJson['version']),
+      version: SemVer.parse(packageJson["version"]),
     },
     featureFlags: {},
   };