bb-relay 0.0.3 → 0.0.5

package/dist/index.d.mts

@@ -465,29 +465,6 @@ interface MenuContent {
 
 type Nav = "file-explorer" | "checkpoints" | "plugins" | "settings" | "remote";
 
-type Plugin = {
-    id: string;
-    slug: string;
-    userId: string;
-    size: number;
-    latestProduction: {
-        version: string;
-        id: number;
-    };
-    latestBeta: {
-        version: string;
-        id: number;
-    };
-    latestAlpha: {
-        version: string;
-        id: number;
-    };
-    latestDraft: {
-        version: string;
-        id: number;
-    };
-};
-
 interface RenameType {
     path: string;
     name: string;
@@ -521,4 +498,61 @@ declare const frFR: {
     [key in Language]: ;
 };
 
-export { type BBEvent, type BBRequest, type Checkpoint, type CopyArg, type DirInfo, type DirectoryContents, type DirectoryStats, type EventReturn, type FileContent, type FileInfo, type GitFileStatus, type IconArg, type Language, type Load, type Locale, type MenuContent, type Nav, type Plugin, type Project, type RenameType, type RequestReturn, type Result, type Route, type Settings, type TutorialHeader, type User, type WatchFSEvent, BBRelay as default, enGB, frFR, injectStyles, registerEvent, registerRequest };
+type Release = {
+    storageRef: string;
+    changes: string;
+    version: string;
+    type: "production" | "beta" | "alpha" | "draft";
+    slug: string;
+    metadata: {
+        uploadedAt: number;
+        totalFiles: number;
+        totalSize: number;
+    };
+    createdAt: string;
+    id?: string;
+};
+
+type Status = Omit<Release, "type">;
+/**
+ * This will be pulled from two firestore
+ * The part of name, description etc will be in the main
+ * Things like installs will be in the registry
+ */
+type Plugin = {
+    userId: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    installs: number;
+    archived?: boolean;
+    deprecated?: boolean;
+    alpha: Status | null;
+    beta: Status | null;
+    production: Status | null;
+    createdAt: string;
+    updatedAt: string;
+};
+
+interface FileNode {
+    name: string;
+    path: string;
+    type: "file" | "folder";
+    size?: number;
+    content?: string | ArrayBuffer;
+    mimeType?: string;
+    children?: FileNode[];
+}
+interface Zip {
+    files: FileNode[];
+    totalFiles: number;
+    totalSize: number;
+}
+
+type ValidateManifestProp = {
+    text: string;
+    id: string;
+};
+declare const validateManifest: (manifestContent: string) => ValidateManifestProp[];
+
+export { type BBEvent, type BBRequest, type Checkpoint, type CopyArg, type DirInfo, type DirectoryContents, type DirectoryStats, type EventReturn, type FileContent, type FileInfo, type GitFileStatus, type IconArg, type Language, type Load, type Locale, type MenuContent, type Nav, type Plugin, type Project, type Release, type RenameType, type RequestReturn, type Result, type Route, type Settings, type TutorialHeader, type User, type ValidateManifestProp, type WatchFSEvent, type Zip, BBRelay as default, enGB, frFR, injectStyles, registerEvent, registerRequest, validateManifest };

package/dist/index.d.ts

@@ -465,29 +465,6 @@ interface MenuContent {
 
 type Nav = "file-explorer" | "checkpoints" | "plugins" | "settings" | "remote";
 
-type Plugin = {
-    id: string;
-    slug: string;
-    userId: string;
-    size: number;
-    latestProduction: {
-        version: string;
-        id: number;
-    };
-    latestBeta: {
-        version: string;
-        id: number;
-    };
-    latestAlpha: {
-        version: string;
-        id: number;
-    };
-    latestDraft: {
-        version: string;
-        id: number;
-    };
-};
-
 interface RenameType {
     path: string;
     name: string;
@@ -521,4 +498,61 @@ declare const frFR: {
     [key in Language]: ;
 };
 
-export { type BBEvent, type BBRequest, type Checkpoint, type CopyArg, type DirInfo, type DirectoryContents, type DirectoryStats, type EventReturn, type FileContent, type FileInfo, type GitFileStatus, type IconArg, type Language, type Load, type Locale, type MenuContent, type Nav, type Plugin, type Project, type RenameType, type RequestReturn, type Result, type Route, type Settings, type TutorialHeader, type User, type WatchFSEvent, BBRelay as default, enGB, frFR, injectStyles, registerEvent, registerRequest };
+type Release = {
+    storageRef: string;
+    changes: string;
+    version: string;
+    type: "production" | "beta" | "alpha" | "draft";
+    slug: string;
+    metadata: {
+        uploadedAt: number;
+        totalFiles: number;
+        totalSize: number;
+    };
+    createdAt: string;
+    id?: string;
+};
+
+type Status = Omit<Release, "type">;
+/**
+ * This will be pulled from two firestore
+ * The part of name, description etc will be in the main
+ * Things like installs will be in the registry
+ */
+type Plugin = {
+    userId: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    installs: number;
+    archived?: boolean;
+    deprecated?: boolean;
+    alpha: Status | null;
+    beta: Status | null;
+    production: Status | null;
+    createdAt: string;
+    updatedAt: string;
+};
+
+interface FileNode {
+    name: string;
+    path: string;
+    type: "file" | "folder";
+    size?: number;
+    content?: string | ArrayBuffer;
+    mimeType?: string;
+    children?: FileNode[];
+}
+interface Zip {
+    files: FileNode[];
+    totalFiles: number;
+    totalSize: number;
+}
+
+type ValidateManifestProp = {
+    text: string;
+    id: string;
+};
+declare const validateManifest: (manifestContent: string) => ValidateManifestProp[];
+
+export { type BBEvent, type BBRequest, type Checkpoint, type CopyArg, type DirInfo, type DirectoryContents, type DirectoryStats, type EventReturn, type FileContent, type FileInfo, type GitFileStatus, type IconArg, type Language, type Load, type Locale, type MenuContent, type Nav, type Plugin, type Project, type Release, type RenameType, type RequestReturn, type Result, type Route, type Settings, type TutorialHeader, type User, type ValidateManifestProp, type WatchFSEvent, type Zip, BBRelay as default, enGB, frFR, injectStyles, registerEvent, registerRequest, validateManifest };

package/dist/index.js

@@ -25,7 +25,8 @@ __export(src_exports, {
   frFR: () => fr_FR_default,
   injectStyles: () => injectStyles,
   registerEvent: () => registerEvent,
-  registerRequest: () => registerRequest
+  registerRequest: () => registerRequest,
+  validateManifest: () => validate_manifest_default
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -393,6 +394,37 @@ var frFR = {
 };
 var fr_FR_default = frFR;
 
+// src/lib/validate-manifest.ts
+var validateManifest = (manifestContent) => {
+  const checks = [];
+  const content = JSON.parse(manifestContent);
+  if (!content.id) {
+    checks.push({
+      text: "Manifest id is missing",
+      id: "manifest-id"
+    });
+  }
+  if (!content.manifest_version) {
+    checks.push({
+      text: "Manifest manifest_version is missing",
+      id: "manifest-version"
+    });
+  } else if (content.manifest_version !== 1) {
+    checks.push({
+      text: "Manifest manifest_version should be 1",
+      id: "manifest-version"
+    });
+  }
+  if (!content.version) {
+    checks.push({
+      text: "Plugin version not provided",
+      id: "plugin-version"
+    });
+  }
+  return checks;
+};
+var validate_manifest_default = validateManifest;
+
 // src/index.ts
 var src_default = BBRelay;
 // Annotate the CommonJS export names for ESM import in node:
@@ -401,5 +433,6 @@ var src_default = BBRelay;
   frFR,
   injectStyles,
   registerEvent,
-  registerRequest
+  registerRequest,
+  validateManifest
 });

package/dist/index.mjs

@@ -364,6 +364,37 @@ var frFR = {
 };
 var fr_FR_default = frFR;
 
+// src/lib/validate-manifest.ts
+var validateManifest = (manifestContent) => {
+  const checks = [];
+  const content = JSON.parse(manifestContent);
+  if (!content.id) {
+    checks.push({
+      text: "Manifest id is missing",
+      id: "manifest-id"
+    });
+  }
+  if (!content.manifest_version) {
+    checks.push({
+      text: "Manifest manifest_version is missing",
+      id: "manifest-version"
+    });
+  } else if (content.manifest_version !== 1) {
+    checks.push({
+      text: "Manifest manifest_version should be 1",
+      id: "manifest-version"
+    });
+  }
+  if (!content.version) {
+    checks.push({
+      text: "Plugin version not provided",
+      id: "plugin-version"
+    });
+  }
+  return checks;
+};
+var validate_manifest_default = validateManifest;
+
 // src/index.ts
 var src_default = BBRelay;
 export {
@@ -372,5 +403,6 @@ export {
   fr_FR_default as frFR,
   injectStyles,
   registerEvent,
-  registerRequest
+  registerRequest,
+  validate_manifest_default as validateManifest
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bb-relay",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "For managing bb-editor extension",
   "license": "ISC",
   "author": "Ade Adeola",

package/src/index.ts

@@ -22,7 +22,6 @@ import Language from "./types/editor/Language";
 import Locale from "./types/editor/Locale";
 import { MenuContent } from "./types/editor/MenuContent";
 import Nav from "./types/editor/Nav";
-import { Plugin } from "./types/editor/Plugin";
 import Project from "./types/project/Project";
 import { RenameType } from "./types/editor/RenameType";
 import Result from "./types/editor/Result";
@@ -31,11 +30,17 @@ import { Settings } from "./types/editor/Settings";
 import { TutorialHeader } from "./types/editor/TutorialHeader";
 import enGB from "./locales/en-GB";
 import frFR from "./locales/fr-FR";
+import { Release } from "./types/plugins/Release";
+import { Plugin } from "./types/plugins/Plugin";
+import { Zip } from "./types/Zip";
+import validateManifest, {
+  ValidateManifestProp,
+} from "./lib/validate-manifest";
 
 export default BBRelay;
 
 export { registerRequest, injectStyles, registerEvent };
-
+export { validateManifest };
 export type {
   BBRequest,
   DirInfo,
@@ -58,7 +63,6 @@ export type {
   Locale,
   MenuContent,
   Nav,
-  Plugin,
   Project,
   RenameType,
   Result,
@@ -69,4 +73,5 @@ export type {
   WatchFSEvent,
 };
 
+export type { Release, Plugin, Zip, ValidateManifestProp };
 export { enGB, frFR };

package/src/lib/validate-manifest.ts

@@ -0,0 +1,37 @@
+export type ValidateManifestProp = {
+  text: string;
+  id: string;
+};
+
+const validateManifest = (manifestContent: string) => {
+  const checks: ValidateManifestProp[] = [];
+  const content: Record<string, unknown> = JSON.parse(manifestContent);
+
+  if (!content.id) {
+    checks.push({
+      text: "Manifest id is missing",
+      id: "manifest-id",
+    });
+  }
+  if (!content.manifest_version) {
+    checks.push({
+      text: "Manifest manifest_version is missing",
+      id: "manifest-version",
+    });
+  } else if (content.manifest_version !== 1) {
+    checks.push({
+      text: "Manifest manifest_version should be 1",
+      id: "manifest-version",
+    });
+  }
+  if (!content.version) {
+    checks.push({
+      text: "Plugin version not provided",
+      id: "plugin-version",
+    });
+  }
+
+  return checks;
+};
+
+export default validateManifest;

package/src/types/Zip.ts

@@ -0,0 +1,15 @@
+interface FileNode {
+  name: string;
+  path: string;
+  type: "file" | "folder";
+  size?: number;
+  content?: string | ArrayBuffer;
+  mimeType?: string;
+  children?: FileNode[];
+}
+
+export interface Zip {
+  files: FileNode[];
+  totalFiles: number;
+  totalSize: number;
+}

package/src/types/plugins/Plugin.ts

@@ -0,0 +1,22 @@
+import { Release } from "./Release";
+
+type Status = Omit<Release, "type">;
+/**
+ * This will be pulled from two firestore
+ * The part of name, description etc will be in the main
+ * Things like installs will be in the registry
+ */
+export type Plugin = {
+  userId: string;
+  slug: string;
+  name: string;
+  description: string | null;
+  installs: number;
+  archived?: boolean;
+  deprecated?: boolean;
+  alpha: Status | null;
+  beta: Status | null;
+  production: Status | null;
+  createdAt: string;
+  updatedAt: string;
+};

package/src/types/plugins/Release.ts

@@ -0,0 +1,14 @@
+export type Release = {
+  storageRef: string;
+  changes: string;
+  version: string;
+  type: "production" | "beta" | "alpha" | "draft";
+  slug: string;
+  metadata: {
+    uploadedAt: number;
+    totalFiles: number;
+    totalSize: number;
+  };
+  createdAt: string;
+  id?: string
+};

package/src/types/editor/Plugin.ts

@@ -1,22 +0,0 @@
-export type Plugin = {
-  id: string;
-  slug: string;
-  userId: string;
-  size: number;
-  latestProduction: {
-    version: string;
-    id: number;
-  };
-  latestBeta: {
-    version: string;
-    id: number;
-  };
-  latestAlpha: {
-    version: string;
-    id: number;
-  };
-  latestDraft: {
-    version: string;
-    id: number;
-  };
-};