@sia-ui/registry 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,46 @@
+/**
+ * Le cycle de vie d'une entrée.
+ *
+ * Quatre états, et un seul sens de circulation : une entrée naît
+ * `experimental`, se stabilise, se déprécie, puis disparaît. Sans eux, retirer
+ * un composant déjà copié chez quelqu'un revient à le supprimer sans
+ * prévenir — le fichier reste chez lui, et plus rien ne dit qu'il ne faut plus
+ * s'en servir.
+ */
+type RegistryStatus = "experimental" | "stable" | "deprecated" | "removed";
+/**
+ * Une entrée installable.
+ *
+ * Déclarée ici, et nulle part ailleurs : c'est la forme du registre, donc la
+ * forme de ce paquet. Décrire un fichier à copier ne demande rien d'autre,
+ * et surtout pas de dépendre d'un paquet d'interface.
+ */
+interface RegistryItem {
+    name: string;
+    description: string;
+    type: "primitive" | "component" | "pattern";
+    /**
+     * La version de l'entrée, pas celle des paquets.
+     *
+     * Un composant copié chez quelqu'un ne suit plus `@sia-ui/react-web` : il
+     * vit dans son dépôt à lui. C'est ce numéro, noté dans son `sia-ui.lock.json`
+     * au moment de la copie, qui permet plus tard de dire ce qui a bougé depuis.
+     */
+    version: string;
+    status: RegistryStatus;
+    /** D'où viennent les fichiers. Une seule source aujourd'hui. */
+    source: "package";
+    files: string[];
+    dependencies?: string[];
+    registryDependencies?: string[];
+    /** Pour `deprecated` et `removed` : l'entrée qui prend la suite. */
+    replacedBy?: string;
+    /** Pourquoi, en une phrase. Affiché par la CLI au moment de l'installation. */
+    deprecatedReason?: string;
+}
+declare const registry: RegistryItem[];
+declare function getRegistryItem(name: string): RegistryItem | undefined;
+/** Les entrées encore installables, dans l'ordre du registre. */
+declare function installableItems(): RegistryItem[];
+
+export { type RegistryItem, type RegistryStatus, getRegistryItem, installableItems, registry };

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Le cycle de vie d'une entrée.
+ *
+ * Quatre états, et un seul sens de circulation : une entrée naît
+ * `experimental`, se stabilise, se déprécie, puis disparaît. Sans eux, retirer
+ * un composant déjà copié chez quelqu'un revient à le supprimer sans
+ * prévenir — le fichier reste chez lui, et plus rien ne dit qu'il ne faut plus
+ * s'en servir.
+ */
+type RegistryStatus = "experimental" | "stable" | "deprecated" | "removed";
+/**
+ * Une entrée installable.
+ *
+ * Déclarée ici, et nulle part ailleurs : c'est la forme du registre, donc la
+ * forme de ce paquet. Décrire un fichier à copier ne demande rien d'autre,
+ * et surtout pas de dépendre d'un paquet d'interface.
+ */
+interface RegistryItem {
+    name: string;
+    description: string;
+    type: "primitive" | "component" | "pattern";
+    /**
+     * La version de l'entrée, pas celle des paquets.
+     *
+     * Un composant copié chez quelqu'un ne suit plus `@sia-ui/react-web` : il
+     * vit dans son dépôt à lui. C'est ce numéro, noté dans son `sia-ui.lock.json`
+     * au moment de la copie, qui permet plus tard de dire ce qui a bougé depuis.
+     */
+    version: string;
+    status: RegistryStatus;
+    /** D'où viennent les fichiers. Une seule source aujourd'hui. */
+    source: "package";
+    files: string[];
+    dependencies?: string[];
+    registryDependencies?: string[];
+    /** Pour `deprecated` et `removed` : l'entrée qui prend la suite. */
+    replacedBy?: string;
+    /** Pourquoi, en une phrase. Affiché par la CLI au moment de l'installation. */
+    deprecatedReason?: string;
+}
+declare const registry: RegistryItem[];
+declare function getRegistryItem(name: string): RegistryItem | undefined;
+/** Les entrées encore installables, dans l'ordre du registre. */
+declare function installableItems(): RegistryItem[];
+
+export { type RegistryItem, type RegistryStatus, getRegistryItem, installableItems, registry };