@lorion-org/registry-hub 1.0.0-beta.0 → 1.0.0-beta.2

package/README.md

@@ -39,17 +39,21 @@ import { createRegistry, createRegistryHub } from '@lorion-org/registry-hub';
 ```ts
 import { createRegistry, type RegistryItem } from '@lorion-org/registry-hub';
 
-type Command = RegistryItem & {
-  command: string;
+type PaymentProvider = RegistryItem & {
+  createCheckoutPath: (input: { shopId: string }) => string;
 };
 
-const commands = createRegistry<Command>('commands');
+const paymentProviders = createRegistry<PaymentProvider>('payment-checkout-providers');
 
-commands.register({ id: 'build', command: 'pnpm build' });
+paymentProviders.register({
+  id: 'payment-provider-stripe',
+  createCheckoutPath: (input) =>
+    `/providers/payment-provider-stripe/checkout?shop=${encodeURIComponent(input.shopId)}`,
+});
 
-commands.get('build');
-commands.list();
-commands.entries();
+paymentProviders.get('payment-provider-stripe');
+paymentProviders.list();
+paymentProviders.entries();
 ```
 
 ### Use a registry hub
@@ -57,37 +61,38 @@ commands.entries();
 ```ts
 import { createRegistryHub, type RegistryItem } from '@lorion-org/registry-hub';
 
-type Tool = RegistryItem & {
-  title: string;
+type Shop = RegistryItem & {
+  path: string;
 };
 
 const hub = createRegistryHub();
 
-hub.createRegistry<Tool>('tools');
-hub.register<Tool>('tools', { id: 'lint', title: 'Lint workspace' });
+hub.createRegistry<Shop>('shops');
+hub.register<Shop>('shops', { id: 'shop-coffee', path: '/shops/coffee' });
 
-const tool = hub.get<Tool>('tools', 'lint');
-const tools = hub.list<Tool>('tools');
+const shop = hub.get<Shop>('shops', 'shop-coffee');
+const shops = hub.list<Shop>('shops');
 const registries = hub.entries();
 ```
 
-### Renderer registry example
+### Shop registry example
 
 ```ts
 import { createRegistry, type RegistryItem } from '@lorion-org/registry-hub';
 
-type FieldRenderer = RegistryItem & {
-  component: string;
+type Shop = RegistryItem & {
+  name: string;
+  path: string;
 };
 
-const renderers = createRegistry<FieldRenderer>('field-renderers');
+const shops = createRegistry<Shop>('shops');
 
-renderers.register([
-  { id: 'text', component: 'TextFieldRenderer' },
-  { id: 'date', component: 'DateFieldRenderer' },
+shops.register([
+  { id: 'shop-coffee', name: 'Bean Supply', path: '/shops/coffee' },
+  { id: 'shop-stationery', name: 'Paper Desk', path: '/shops/stationery' },
 ]);
 
-const knownRenderers = renderers.entries();
+const knownShops = shops.entries();
 ```
 
 ### Framework recipe
@@ -113,14 +118,16 @@ Another plugin can then consume that injected hub and register its own entries.
 ```ts
 import type { RegistryItem } from '@lorion-org/registry-hub';
 
-type Tool = RegistryItem & {
-  title: string;
+type Shop = RegistryItem & {
+  name: string;
+  path: string;
 };
 
 export default defineNuxtPlugin((nuxtApp) => {
-  nuxtApp.$registryHub.register<Tool>('tools', {
-    id: 'lint',
-    title: 'Lint workspace',
+  nuxtApp.$registryHub.register<Shop>('shops', {
+    id: 'shop-coffee',
+    name: 'Bean Supply',
+    path: '/shops/coffee',
   });
 });
 ```
@@ -130,18 +137,19 @@ A composable can later load all entries of one typed registry from that same hub
 ```ts
 import type { RegistryItem } from '@lorion-org/registry-hub';
 
-type Tool = RegistryItem & {
-  title: string;
+type Shop = RegistryItem & {
+  name: string;
+  path: string;
 };
 
-export function useTools(): Tool[] {
-  return useNuxtApp().$registryHub.list<Tool>('tools');
+export function useShops(): Shop[] {
+  return useNuxtApp().$registryHub.list<Shop>('shops');
 }
 ```
 
 Runnable example files live in [`examples/`](./examples).
 The Node example imports the published package name instead of local source files so it mirrors real consumer usage.
-The examples use neutral domain names so the package can be understood as a generic registry utility.
+The examples use the same shop and checkout-provider domain as the LORION playgrounds.
 
 ## Local commands
 

package/examples/node-basic.js

@@ -3,8 +3,12 @@ import process from 'node:process';
 
 const hub = createRegistryHub();
 
-hub.register('commands', { id: 'build', command: 'pnpm build' });
-hub.register('tools', { id: 'lint', title: 'Lint workspace' });
+hub.register('payment-checkout-providers', {
+  id: 'payment-provider-stripe',
+  createCheckoutPath: (input) =>
+    `/providers/payment-provider-stripe/checkout?shop=${encodeURIComponent(input.shopId)}`,
+});
+hub.register('shops', { id: 'shop-coffee', path: '/shops/coffee' });
 
-process.stdout.write(`${JSON.stringify(hub.list('commands'))}\n`);
-process.stdout.write(`${JSON.stringify(hub.get('tools', 'lint'))}\n`);
+process.stdout.write(`${JSON.stringify(hub.list('payment-checkout-providers'))}\n`);
+process.stdout.write(`${JSON.stringify(hub.get('shops', 'shop-coffee'))}\n`);

package/examples/node-basic.ts

@@ -1,20 +1,24 @@
 import { createRegistryHub, type RegistryItem } from '@lorion-org/registry-hub';
 
-type Command = RegistryItem & {
-  command: string;
+type PaymentProvider = RegistryItem & {
+  createCheckoutPath: (input: { shopId: string }) => string;
 };
 
-type Tool = RegistryItem & {
-  title: string;
+type Shop = RegistryItem & {
+  path: string;
 };
 
 const hub = createRegistryHub();
 
-hub.register<Command>('commands', { id: 'build', command: 'pnpm build' });
-hub.register<Tool>('tools', { id: 'lint', title: 'Lint workspace' });
+hub.register<PaymentProvider>('payment-checkout-providers', {
+  id: 'payment-provider-stripe',
+  createCheckoutPath: (input) =>
+    `/providers/payment-provider-stripe/checkout?shop=${encodeURIComponent(input.shopId)}`,
+});
+hub.register<Shop>('shops', { id: 'shop-coffee', path: '/shops/coffee' });
 
-console.log(hub.list<Command>('commands'));
-// [{ id: 'build', command: 'pnpm build' }]
+console.log(hub.list<PaymentProvider>('payment-checkout-providers'));
+// [{ id: 'payment-provider-stripe', createCheckoutPath: [Function] }]
 
-console.log(hub.get<Tool>('tools', 'lint'));
-// { id: 'lint', title: 'Lint workspace' }
+console.log(hub.get<Shop>('shops', 'shop-coffee'));
+// { id: 'shop-coffee', path: '/shops/coffee' }

package/examples/renderer-registry.js

@@ -1,15 +1,15 @@
 import { createRegistry } from '@lorion-org/registry-hub';
 import process from 'node:process';
 
-const renderers = createRegistry('field-renderers');
+const shops = createRegistry('shops');
 
-renderers.register([
-  { id: 'text', component: 'TextFieldRenderer' },
-  { id: 'date', component: 'DateFieldRenderer' },
+shops.register([
+  { id: 'shop-coffee', name: 'Bean Supply', path: '/shops/coffee' },
+  { id: 'shop-stationery', name: 'Paper Desk', path: '/shops/stationery' },
 ]);
 
 process.stdout.write(
-  `${renderers.id}:${renderers
+  `${shops.id}:${shops
     .entries()
     .map(([id]) => id)
     .join(',')}\n`,

package/examples/renderer-registry.ts

@@ -1,18 +1,19 @@
 import { createRegistry, type RegistryItem } from '@lorion-org/registry-hub';
 
-type FieldRenderer = RegistryItem & {
-  component: string;
+type Shop = RegistryItem & {
+  name: string;
+  path: string;
 };
 
-const renderers = createRegistry<FieldRenderer>('field-renderers');
+const shops = createRegistry<Shop>('shops');
 
-renderers.register([
-  { id: 'text', component: 'TextFieldRenderer' },
-  { id: 'date', component: 'DateFieldRenderer' },
+shops.register([
+  { id: 'shop-coffee', name: 'Bean Supply', path: '/shops/coffee' },
+  { id: 'shop-stationery', name: 'Paper Desk', path: '/shops/stationery' },
 ]);
 
-console.log(renderers.entries());
+console.log(shops.entries());
 // [
-//   ['text', { id: 'text', component: 'TextFieldRenderer' }],
-//   ['date', { id: 'date', component: 'DateFieldRenderer' }]
+//   ['shop-coffee', { id: 'shop-coffee', name: 'Bean Supply', path: '/shops/coffee' }],
+//   ['shop-stationery', { id: 'shop-stationery', name: 'Paper Desk', path: '/shops/stationery' }]
 // ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lorion-org/registry-hub",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.2",
   "description": "Framework-free typed registry and registry-hub primitives.",
   "license": "MIT",
   "repository": {
@@ -22,6 +22,10 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "lorion-source": {
+        "types": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
       "import": {
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
@@ -35,7 +39,9 @@
   "files": [
     "dist",
     "examples",
-    "LICENSE"
+    "LICENSE",
+    "src/**/*.ts",
+    "!src/**/*.spec.ts"
   ],
   "keywords": [
     "registry",

package/src/index.ts

@@ -0,0 +1,83 @@
+export type RegistryItem = {
+  id: string;
+};
+
+export type Registry<T extends RegistryItem = RegistryItem> = {
+  id: string;
+  get: (id: string) => T | undefined;
+  list: () => T[];
+  register: (items: T | T[]) => T[];
+  entries: () => Array<[string, T]>;
+};
+
+export type RegistryHub = {
+  createRegistry: <T extends RegistryItem>(id: string) => Registry<T>;
+  getRegistry: <T extends RegistryItem>(id: string) => Registry<T> | undefined;
+  register: <T extends RegistryItem>(registryId: string, items: T | T[]) => T[];
+  get: <T extends RegistryItem>(registryId: string, itemId: string) => T | undefined;
+  list: <T extends RegistryItem>(registryId: string) => T[];
+  entries: () => Array<[string, Registry<RegistryItem>]>;
+};
+
+type AnyRegistry = Registry<RegistryItem>;
+
+export function createRegistry<T extends RegistryItem>(id: string): Registry<T> {
+  const map: Map<string, T> = new Map();
+
+  return {
+    id,
+    get: (itemId: string) => map.get(itemId),
+    list: () => Array.from(map.values()),
+    entries: () => Array.from(map.entries()),
+    register: (items: T | T[]) => {
+      const normalized: T[] = Array.isArray(items) ? items : [items];
+
+      for (const item of normalized) map.set(item.id, item);
+
+      return normalized;
+    },
+  };
+}
+
+export function createRegistryHub(): RegistryHub {
+  const registries: Map<string, AnyRegistry> = new Map();
+
+  return {
+    createRegistry: <T extends RegistryItem>(id: string) => {
+      const existing: AnyRegistry | undefined = registries.get(id);
+
+      if (existing) return existing as unknown as Registry<T>;
+
+      const created: Registry<T> = createRegistry<T>(id);
+      registries.set(id, created as unknown as AnyRegistry);
+
+      return created;
+    },
+    getRegistry: <T extends RegistryItem>(id: string) =>
+      registries.get(id) as Registry<T> | undefined,
+    register: <T extends RegistryItem>(registryId: string, items: T | T[]) => {
+      const registry: Registry<T> =
+        (registries.get(registryId) as Registry<T> | undefined) ?? createRegistry<T>(registryId);
+
+      if (!registries.has(registryId))
+        registries.set(registryId, registry as unknown as AnyRegistry);
+
+      return registry.register(items);
+    },
+    get: <T extends RegistryItem>(registryId: string, itemId: string) => {
+      const registry: Registry<T> | undefined = registries.get(registryId) as
+        | Registry<T>
+        | undefined;
+
+      return registry?.get(itemId);
+    },
+    list: <T extends RegistryItem>(registryId: string) => {
+      const registry: Registry<T> | undefined = registries.get(registryId) as
+        | Registry<T>
+        | undefined;
+
+      return registry?.list() ?? [];
+    },
+    entries: () => Array.from(registries.entries()),
+  };
+}