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

package/src/block_registry/block_pack_spec.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+import { BlockPackId } from '../block_meta';
+
+/** Block pack from local folder, to be used during block development. Old layout.
+ * @deprecated don't use */
+export const BlockPackDevV1 = z.object({
+  type: z.literal('dev-v1'),
+  folder: z.string(),
+  mtime: z.string().optional()
+});
+/** @deprecated don't use */
+export type BlockPackDevV1 = z.infer<typeof BlockPackDevV1>;
+
+/** Block pack from local folder, to be used during block development. New layout. */
+export const BlockPackDevV2 = z.object({
+  type: z.literal('dev-v2'),
+  folder: z.string(),
+  mtime: z.string().optional()
+});
+export type BlockPackDevV2 = z.infer<typeof BlockPackDevV2>;
+
+/**
+ * Block pack from registry with version 2 layout, to be loaded directly
+ * from the client.
+ * @deprecated don't use
+ * */
+export const BlockPackFromRegistryV1 = z.object({
+  type: z.literal('from-registry-v1'),
+  registryUrl: z.string(),
+  id: BlockPackId
+});
+/** @deprecated don't use */
+export type BlockPackFromRegistryV1 = z.infer<typeof BlockPackFromRegistryV1>;
+
+/** Block pack from registry with version 2 layout, to be loaded directly
+ * from the client. */
+export const BlockPackFromRegistryV2 = z.object({
+  type: z.literal('from-registry-v2'),
+  registryUrl: z.string(),
+  id: BlockPackId
+});
+export type BlockPackFromRegistryV2 = z.infer<typeof BlockPackFromRegistryV2>;
+
+/** Information about block origin, can be used to instantiate new blocks */
+export const BlockPackSpec = z.discriminatedUnion('type', [
+  BlockPackDevV1,
+  BlockPackDevV2,
+  BlockPackFromRegistryV1,
+  BlockPackFromRegistryV2
+]);
+export type BlockPackSpec = z.infer<typeof BlockPackSpec>;

package/src/block_registry/index.ts

@@ -0,0 +1,3 @@
+export * from './block_pack_spec';
+export * from './overview';
+export * from './registry_spec';

package/src/block_registry/overview.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+import { BlockPackId, BlockPackMetaEmbeddedBytes, SemVer } from '../block_meta';
+import { BlockPackSpec } from './block_pack_spec';
+import { RegistryEntry } from './registry_spec';
+
+/**
+ * Latest information about specific block pack. Contain information about latest version of the package.
+ * */
+export const BlockPackOverview = z.object({
+  registryId: z.string(),
+  id: BlockPackId,
+  meta: BlockPackMetaEmbeddedBytes,
+  spec: BlockPackSpec,
+  otherVersions: z.array(SemVer)
+});
+export type BlockPackOverview = z.infer<typeof BlockPackOverview>;
+
+export const RegistryStatus = RegistryEntry.extend({
+  status: z.union([z.literal('online'), z.literal('offline')])
+});
+export type RegistryStatus = z.infer<typeof RegistryStatus>;
+
+export const BlockPackListing = z.object({
+  registries: z.array(RegistryStatus),
+  blockPacks: z.array(BlockPackOverview)
+});
+export type BlockPackListing = z.infer<typeof BlockPackListing>;

package/src/block_registry/registry_spec.ts

@@ -0,0 +1,38 @@
+import { z } from 'zod';
+
+export const LocalDevFolder = z.object({
+  type: z.literal('local-dev'),
+  path: z.string()
+});
+export type LocalDevFolder = z.infer<typeof LocalDevFolder>;
+
+/** @deprecated don't use */
+export const RemoteRegistryV1Spec = z.object({
+  type: z.literal('remote-v1'),
+  url: z.string().url()
+});
+/** @deprecated don't use */
+export type RemoteRegistryV1Spec = z.infer<typeof RemoteRegistryV1Spec>;
+
+export const RemoteRegistryV2Spec = z.object({
+  type: z.literal('remote-v2'),
+  url: z.string().url()
+});
+export type RemoteRegistryV2Spec = z.infer<typeof RemoteRegistryV2Spec>;
+
+export const RegistrySpec = z.discriminatedUnion('type', [
+  RemoteRegistryV1Spec,
+  RemoteRegistryV2Spec,
+  LocalDevFolder
+]);
+export type RegistrySpec = z.infer<typeof RegistrySpec>;
+
+export const RegistryEntry = z.object({
+  id: z.string(),
+  title: z.string().optional(),
+  spec: RegistrySpec
+});
+export type RegistryEntry = z.infer<typeof RegistryEntry>;
+
+export const RegistryList = z.array(RegistryEntry);
+export type RegistryList = z.infer<typeof RegistryList>;

package/src/index.ts

@@ -1,5 +1,5 @@
 export * from './author_marker';
-export * from './block_pack';
+export * from './block_registry';
 export * from './block_state';
 export * from './block_meta';
 export * from './project';

package/src/project_overview.ts

@@ -1,5 +1,5 @@
 import { ProjectMeta } from './project';
-import { BlockPackSpec } from './block_pack';
+import { BlockPackSpec } from './block_registry/block_pack_spec';
 import { BlockRenderingMode, BlockSection, NavigationState } from '@milaboratories/pl-model-common';
 import { AuthorMarker } from './author_marker';
 

package/dist/block_pack.d.ts

@@ -1,24 +0,0 @@
-/** Block pack from local folder, to be used during block development. Legacy layout. */
-export interface BlockPackDevV1 {
-    type: 'dev' | 'dev-v1';
-    folder: string;
-    mtime?: string;
-}
-/** Block pack from local folder, to be used during block development. New layout. */
-export interface BlockPackDevV2 {
-    type: 'dev-v2';
-    folder: string;
-    mtime?: string;
-}
-/** Block pack from registry with version 1 layout, to be loaded directly
- * from the client. */
-export interface BlockPackFromRegistryV1 {
-    type: 'from-registry-v1';
-    registryUrl: string;
-    organization: string;
-    package: string;
-    version: string;
-}
-/** Information about block origin, can be used to instantiate new blocks */
-export type BlockPackSpec = BlockPackDevV1 | BlockPackDevV2 | BlockPackFromRegistryV1;
-//# sourceMappingURL=block_pack.d.ts.map

package/dist/block_pack.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"block_pack.d.ts","sourceRoot":"","sources":["../src/block_pack.ts"],"names":[],"mappings":"AAAA,wFAAwF;AACxF,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,KAAK,GAAG,QAAQ,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qFAAqF;AACrF,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;sBACsB;AACtB,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,kBAAkB,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,4EAA4E;AAC5E,MAAM,MAAM,aAAa,GACrB,cAAc,GACd,cAAc,GACd,uBAAuB,CAAC"}

package/src/block_pack.ts

@@ -1,29 +0,0 @@
-/** Block pack from local folder, to be used during block development. Legacy layout. */
-export interface BlockPackDevV1 {
-  type: 'dev' | 'dev-v1';
-  folder: string;
-  mtime?: string;
-}
-
-/** Block pack from local folder, to be used during block development. New layout. */
-export interface BlockPackDevV2 {
-  type: 'dev-v2';
-  folder: string;
-  mtime?: string;
-}
-
-/** Block pack from registry with version 1 layout, to be loaded directly
- * from the client. */
-export interface BlockPackFromRegistryV1 {
-  type: 'from-registry-v1';
-  registryUrl: string;
-  organization: string;
-  package: string;
-  version: string;
-}
-
-/** Information about block origin, can be used to instantiate new blocks */
-export type BlockPackSpec =
-  | BlockPackDevV1
-  | BlockPackDevV2
-  | BlockPackFromRegistryV1;