@superblocksteam/util 1.9.3 → 1.10.0

package/dist/resource-configs.d.ts

@@ -6,21 +6,34 @@ export type VersionedResourceConfig = {
     location: string;
     resourceType: SuperblocksResourceType;
 };
+export type SuperblocksResourceConfigMetadata = {
+    fileVersion?: string;
+};
 export type SuperblocksResourceConfig = {
     id: string;
+    metadata?: SuperblocksResourceConfigMetadata;
 };
-export type SuperblocksBackendConfig = SuperblocksResourceConfig & {
+export type SuperblocksBackendConfig = SuperblocksResourceConfig & SourceFilesContanier & {
     configType: "BACKEND";
 };
 export type SuperblocksApplicationConfig = SuperblocksResourceConfig & {
     configType: "APPLICATION";
     defaultPageId?: string;
-    apis: Record<string, string>;
-    pages?: Record<string, {
-        id: string;
-        name: string;
-        apis: Record<string, string>;
-    }>;
+    apis?: Record<string, string>;
+    appApis?: Record<string, ApiInfo>;
+    pages?: Record<string, PageInfo>;
+};
+export type PageInfo = {
+    id: string;
+    name: string;
+    apis?: Record<string, string>;
+    pageApis?: Record<string, ApiInfo>;
+};
+export type SourceFilesContanier = {
+    sourceFiles?: string[];
+};
+export type ApiInfo = SourceFilesContanier & {
+    name: string;
 };
 export type SuperblocksMonorepoConfig = {
     configType: "ROOT";
@@ -35,5 +48,6 @@ export type SuperblocksConfig = SuperblocksMonorepoConfig | SuperblocksApplicati
 export declare function getSuperblocksMonorepoConfigJson(checkParentDir?: boolean, pathPrefix?: string): Promise<[SuperblocksMonorepoConfig, string]>;
 export declare function getSuperblocksApplicationConfigJson(applicationPath?: string): Promise<SuperblocksApplicationConfig>;
 export declare function getSuperblocksApplicationConfigIfExists(applicationPath: string): Promise<SuperblocksApplicationConfig | undefined>;
+export declare function getSuperblocksBackendConfigIfExists(backendPath: string): Promise<SuperblocksBackendConfig | undefined>;
 export declare function getSuperblocksBackendConfigJson(): Promise<SuperblocksBackendConfig>;
 export declare function getSuperblocksResourceConfigIfExists(): Promise<SuperblocksResourceConfig | undefined>;

package/dist/resource-configs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSuperblocksResourceConfigIfExists = exports.getSuperblocksBackendConfigJson = exports.getSuperblocksApplicationConfigIfExists = exports.getSuperblocksApplicationConfigJson = exports.getSuperblocksMonorepoConfigJson = void 0;
+exports.getSuperblocksResourceConfigIfExists = exports.getSuperblocksBackendConfigJson = exports.getSuperblocksBackendConfigIfExists = exports.getSuperblocksApplicationConfigIfExists = exports.getSuperblocksApplicationConfigJson = exports.getSuperblocksMonorepoConfigJson = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs = tslib_1.__importStar(require("fs-extra"));
@@ -76,6 +76,23 @@ async function getSuperblocksApplicationConfigIfExists(applicationPath) {
     return superblocksConfig;
 }
 exports.getSuperblocksApplicationConfigIfExists = getSuperblocksApplicationConfigIfExists;
+async function getSuperblocksBackendConfigIfExists(backendPath) {
+    let superblocksConfig;
+    try {
+        const configPath = backendPath
+            ? path_1.default.join(backendPath, constants_1.RESOURCE_CONFIG_PATH)
+            : constants_1.RESOURCE_CONFIG_PATH;
+        superblocksConfig = await fs.readJSON(configPath);
+    }
+    catch {
+        // no superblocks config file found
+    }
+    if ((superblocksConfig === null || superblocksConfig === void 0 ? void 0 : superblocksConfig.configType) !== "BACKEND") {
+        return undefined;
+    }
+    return superblocksConfig;
+}
+exports.getSuperblocksBackendConfigIfExists = getSuperblocksBackendConfigIfExists;
 async function getSuperblocksBackendConfigJson() {
     let superblocksConfig;
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/util",
-  "version": "1.9.3",
+  "version": "1.10.0",
   "main": "dist/index.js",
   "homepage": "https://www.superblocks.com",
   "scripts": {

package/src/resource-configs.ts

@@ -13,26 +13,43 @@ export type VersionedResourceConfig = {
   resourceType: SuperblocksResourceType;
 };
 
+export type SuperblocksResourceConfigMetadata = {
+  fileVersion?: string;
+};
+
 export type SuperblocksResourceConfig = {
   id: string;
+  metadata?: SuperblocksResourceConfigMetadata;
 };
 
-export type SuperblocksBackendConfig = SuperblocksResourceConfig & {
-  configType: "BACKEND";
-};
+export type SuperblocksBackendConfig = SuperblocksResourceConfig &
+  SourceFilesContanier & {
+    configType: "BACKEND";
+  };
 
 export type SuperblocksApplicationConfig = SuperblocksResourceConfig & {
   configType: "APPLICATION";
   defaultPageId?: string;
-  apis: Record<string, string>;
-  pages?: Record<
-    string,
-    {
-      id: string;
-      name: string;
-      apis: Record<string, string>;
-    }
-  >;
+  // @deprecated use pageApis appApis for new format
+  apis?: Record<string, string>; // used for pre-0.2.0 format
+  appApis?: Record<string, ApiInfo>; // used for 0.2.0+ format
+  pages?: Record<string, PageInfo>;
+};
+
+export type PageInfo = {
+  id: string;
+  name: string;
+  // @deprecated use pageApis instead
+  apis?: Record<string, string>; // used for pre-0.2.0 format
+  pageApis?: Record<string, ApiInfo>; // used for 0.2.0+ format
+};
+
+export type SourceFilesContanier = {
+  sourceFiles?: string[];
+};
+
+export type ApiInfo = SourceFilesContanier & {
+  name: string;
 };
 
 export type SuperblocksMonorepoConfig = {
@@ -137,6 +154,26 @@ export async function getSuperblocksApplicationConfigIfExists(
   return superblocksConfig as SuperblocksApplicationConfig;
 }
 
+export async function getSuperblocksBackendConfigIfExists(
+  backendPath: string
+): Promise<SuperblocksBackendConfig | undefined> {
+  let superblocksConfig: SuperblocksBackendConfig | undefined;
+  try {
+    const configPath = backendPath
+      ? path.join(backendPath, RESOURCE_CONFIG_PATH)
+      : RESOURCE_CONFIG_PATH;
+    superblocksConfig = await fs.readJSON(configPath);
+  } catch {
+    // no superblocks config file found
+  }
+
+  if (superblocksConfig?.configType !== "BACKEND") {
+    return undefined;
+  }
+
+  return superblocksConfig as SuperblocksBackendConfig;
+}
+
 export async function getSuperblocksBackendConfigJson(): Promise<SuperblocksBackendConfig> {
   let superblocksConfig;
   try {