zephyr-edge-contract 0.0.2 → 0.0.3

package/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}

package/README.md

@@ -0,0 +1,5 @@
+# zephyr-edge-contract
+
+check [zephyr-webpack-plugin](https://www.npmjs.com/package/zephyr-webpack-plugin) for docs
+
+this is a set API types and reusable functions for zephyr build plugins

package/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'zephyr-edge-contract',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/zephyr-edge-contract',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zephyr-edge-contract",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "license": "Apache-2.0",
   "dependencies": {
     "jose": "^5.2.4",

package/project.json

@@ -0,0 +1,34 @@
+{
+  "name": "zephyr-edge-contract",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/zephyr-edge-contract/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/zephyr-edge-contract",
+        "main": "libs/zephyr-edge-contract/src/index.ts",
+        "tsConfig": "libs/zephyr-edge-contract/tsconfig.lib.json",
+        "assets": ["libs/zephyr-edge-contract/*.md"]
+      }
+    },
+    "publish": {
+      "command": "node tools/scripts/publish.mjs zephyr-edge-contract {args.ver} {args.tag}",
+      "dependsOn": ["build"]
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": ["{options.outputFile}"]
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/zephyr-edge-contract/jest.config.ts"
+      }
+    }
+  },
+  "tags": []
+}

package/src/index.ts

@@ -0,0 +1,36 @@
+export { createFullAppName } from './lib/utils/create-full-app-name';
+export { createSnapshotId } from './lib/utils/create-snapshot-id';
+export { ZeAppVersion, ZeAppVersionResponse } from './lib/ze-api/app-version';
+
+export { ZeApplicationList } from './lib/ze-api/app-list';
+
+export { Snapshot, SnapshotAsset } from './lib/snapshot';
+export { ZeEnvs, ZeUploadBuildStats } from './lib/edge-api/ze-envs-request';
+export * from './lib/zephyr-edge-contract';
+
+export {
+  type GetPersonalAccessTokenFromWebsocketOptions,
+  type AuthOptions,
+  getPersonalAccessTokenFromWebsocket,
+  getAuthenticationURL,
+  checkAuth,
+  isTokenStillValid,
+} from './lib/utils/login';
+export {
+  saveToken,
+  getToken,
+  removeToken,
+  cleanTokens,
+} from './lib/node-persist/token';
+export {
+  ZEPHYR_API_ENDPOINT,
+  v2_api_paths,
+} from './lib/api-contract-negotiation/get-api-contract';
+
+export { getApplicationConfiguration } from './lib/utils/get-application-configuration';
+export {
+  ZeApplicationConfig,
+  getAppConfig,
+  remoteAppConfig,
+  saveAppConfig,
+} from './lib/node-persist/application-configuration';

package/src/lib/api-contract-negotiation/get-api-contract.ts

@@ -0,0 +1,9 @@
+export const ZEPHYR_API_ENDPOINT =
+  process.env['ZE_API'] ?? 'https://api.zephyr-cloud.io';
+
+export const v2_api_paths = {
+  dashboard_path: '/v2/builder-packages-api/upload-from-dashboard-plugin',
+  resolve_dependency_path: '/v2/builder-public-api/resolve',
+  authorize_link: '/v2/authorize-link',
+  application_configuration: '/v2/builder-packages-api/application-config',
+};

package/src/lib/edge-api/ze-envs-request.ts

@@ -0,0 +1,18 @@
+export interface ZeUploadBuildStats {
+  app_version: {
+    application_uid: string;
+    // version.app.repo.org - response from post-upload-snapshot
+    snapshot_id: string;
+  };
+
+  // this is a key for wildcard serving of snapshot, it could be:
+  // default url is `version.app.repo.org
+  // tag: t_tag_name.app.repo.org - optional
+  // env: e_env_name.app.repo.org - optional
+  // cname: cname_value           - optional
+  urls: string[];
+  url_ids: string[];
+  jwt: string;
+}
+
+export type ZeEnvs = ZeUploadBuildStats;

package/src/lib/node-persist/application-configuration.ts

@@ -0,0 +1,34 @@
+import { getItem, init, setItem, removeItem } from 'node-persist';
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+import { StorageKeys, ZE_PATH } from './storage-keys';
+
+export interface ZeApplicationConfig {
+  user_uuid: string;
+  username: string;
+  email: string;
+  AUTH0_CLIENT_ID: string;
+  AUTH0_DOMAIN: string;
+  BUILD_ID_ENDPOINT: string;
+  EDGE_URL: string;
+  jwt: string;
+}
+
+const storage = init({
+  dir: join(homedir(), ZE_PATH),
+});
+
+export async function saveAppConfig(json: ZeApplicationConfig): Promise<void> {
+  await storage;
+  void (await setItem(StorageKeys.ze_app_config_token, json));
+}
+
+export async function getAppConfig(): Promise<ZeApplicationConfig | undefined> {
+  await storage;
+  return getItem(StorageKeys.ze_app_config_token);
+}
+
+export async function remoteAppConfig(): Promise<void> {
+  await storage;
+  await removeItem(StorageKeys.ze_app_config_token);
+}

package/src/lib/node-persist/storage-keys.ts

@@ -0,0 +1,6 @@
+export const ZE_PATH = `.zephyr`;
+
+export const enum StorageKeys {
+  ze_app_config_token = 'ze-application-configuration',
+  zetoken = 'ze-token',
+}

package/src/lib/node-persist/token.ts

@@ -0,0 +1,28 @@
+import { getItem, init, setItem, removeItem, clear } from 'node-persist';
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+import { StorageKeys, ZE_PATH } from './storage-keys';
+
+const storage = init({
+  dir: join(homedir(), ZE_PATH),
+});
+
+export async function saveToken(token: string): Promise<void> {
+  await storage;
+  void (await setItem(StorageKeys.zetoken, token));
+}
+
+export async function getToken(): Promise<string | undefined> {
+  await storage;
+  return getItem(StorageKeys.zetoken);
+}
+
+export async function removeToken(): Promise<void> {
+  await storage;
+  await removeItem(StorageKeys.zetoken);
+}
+
+export async function cleanTokens(): Promise<void> {
+  await storage;
+  await clear();
+}

package/src/lib/snapshot.ts

@@ -0,0 +1,44 @@
+export interface Snapshot {
+  // app.repo.org
+  application_uid: string;
+  // package.json version + descriptor `.(user-(ci|ui?)-user_build_counter)`
+  version: string;
+  // version.app.repo.org
+  snapshot_id: string;
+  // default domain url
+  domain: string;
+  uid: {
+    build: string;
+    app_name: string;
+    repo: string;
+    org: string;
+  };
+  git: {
+    name: string;
+    email: string;
+    branch: string;
+    commit: string;
+  };
+  // zephyr user
+  creator: {
+    name: string;
+    email: string;
+  };
+  createdAt: number;
+  mfConfig?: {
+    name: string;
+    filename: string;
+    exposes?: Record<string, string>
+    remotes?: Record<string, string>;
+    shared?: Record<string, unknown>
+  };
+  // list of files, where key is file path
+  assets: Record<string, SnapshotAsset>;
+}
+
+export interface SnapshotAsset {
+  path: string;
+  extname: string;
+  hash: string;
+  size: number;
+}

package/src/lib/utils/create-full-app-name.ts

@@ -0,0 +1,15 @@
+function replacer(str: string): string {
+  return str.replace(/[^a-zA-Z0-9-_]/gi, '_');
+  // return str.replace(/\W/gi, '_');
+}
+
+export function createFullAppName(options: {
+  org: string;
+  project: string;
+  name: string;
+}): string {
+  const git_org = replacer(options.org);
+  const git_repo = replacer(options.project);
+  const app_name = replacer(options.name);
+  return [app_name, git_repo, git_org].join('.');
+}

package/src/lib/utils/create-snapshot-id.ts

@@ -0,0 +1,9 @@
+import { createFullAppName } from './create-full-app-name';
+
+export function createSnapshotId(options: {
+  app: { org: string; project: string; name: string };
+  zeConfig: { user: string; buildId: string | undefined };
+}): string {
+  const build_id = [options.zeConfig.user, options.zeConfig.buildId].join('_');
+  return [build_id, createFullAppName(options.app)].join('.');
+}

package/src/lib/utils/get-application-configuration.ts

@@ -0,0 +1,65 @@
+import * as jose from 'jose';
+import { cleanTokens, getToken } from '../node-persist/token';
+import {
+  v2_api_paths,
+  ZEPHYR_API_ENDPOINT,
+} from '../api-contract-negotiation/get-api-contract';
+import {
+  getAppConfig,
+  saveAppConfig,
+  ZeApplicationConfig,
+} from '../node-persist/application-configuration';
+import { isTokenStillValid } from './login';
+
+interface GetApplicationConfigurationProps {
+  application_uid: string | undefined;
+}
+
+async function loadApplicationConfiguration({
+  application_uid,
+}: GetApplicationConfigurationProps): Promise<ZeApplicationConfig> {
+  if (!application_uid) {
+    throw new Error(`[zephyr] Critical error: application_uid is missing`);
+  }
+  const token = await getToken();
+  const application_config_url = new URL(
+    v2_api_paths.application_configuration,
+    ZEPHYR_API_ENDPOINT
+  );
+  application_config_url.searchParams.append(
+    'application-uid',
+    application_uid
+  );
+
+  const req = fetch(application_config_url, {
+    headers: { Authorization: 'Bearer ' + token },
+  });
+  req.catch((v) => console.error(v));
+  const response = await req;
+  if (!response.ok && response.status !== 200) {
+    await cleanTokens();
+    const err = new Error('[zephyr]: auth error, please try to build again');
+    err.stack = void 0;
+    throw err;
+  }
+
+  const result = await response.json();
+  return Object.assign({}, result.value, {
+    jwt_decode: jose.decodeJwt(result.value.jwt),
+  });
+}
+
+export async function getApplicationConfiguration({
+  application_uid,
+}: GetApplicationConfigurationProps): Promise<ZeApplicationConfig> {
+  const storedAppConfig = await getAppConfig();
+  if (storedAppConfig && isTokenStillValid(storedAppConfig.jwt)) {
+    return storedAppConfig;
+  }
+
+  const loadedAppConfig = await loadApplicationConfiguration({
+    application_uid,
+  });
+  await saveAppConfig(loadedAppConfig);
+  return loadedAppConfig;
+}

package/src/lib/utils/login.ts

@@ -0,0 +1,125 @@
+import * as open from 'open';
+import * as jose from 'jose';
+import { v4 as uuidv4 } from 'uuid';
+
+import { createSocket, disposeSocket } from './websocket';
+import { removeToken, getToken, saveToken } from '../node-persist/token';
+import {
+  v2_api_paths,
+  ZEPHYR_API_ENDPOINT,
+} from '../api-contract-negotiation/get-api-contract';
+
+export function generateSessionKey(): string {
+  return uuidv4().replace(/-/g, '');
+}
+
+export interface GetPersonalAccessTokenFromWebsocketOptions {
+  openBrowser?: boolean;
+}
+
+export async function getPersonalAccessTokenFromWebsocket(
+  { openBrowser }: GetPersonalAccessTokenFromWebsocketOptions = {
+    openBrowser: true,
+  },
+): Promise<string> {
+  const sessionKey = generateSessionKey();
+  if (openBrowser) {
+    const authUrl = await getAuthenticationURL({ state: sessionKey });
+    await open(authUrl);
+  }
+  return await subscribeToWsEvents(sessionKey);
+}
+
+export interface AuthOptions {
+  state: string;
+  responseType?: string;
+  scope?: string;
+}
+
+export async function getAuthenticationURL(
+  options: AuthOptions,
+): Promise<string> {
+  const { state } = options;
+  const loginUrl = new URL(v2_api_paths.authorize_link, ZEPHYR_API_ENDPOINT);
+  loginUrl.searchParams.append('state', state);
+
+  return fetch(loginUrl.href).then((res) => res.text());
+}
+
+/**
+ * Check if the user is already authenticated. If not, open a browser window to authenticate.
+ * Display a message to the console.
+ * @return The token as a string.
+ */
+export async function checkAuth(): Promise<string> {
+  const token = await getToken();
+
+  if (token) {
+    // Check if the token has a valid expiration date.
+    if (isTokenStillValid(token)) {
+      console.log('[zephyr] You are already logged in');
+      return token;
+    }
+    await removeToken();
+  }
+
+  // No valid token found; initiate authentication.
+  const newToken = await authenticateUser();
+  console.log('[zephyr] You are logged in');
+
+  return newToken;
+}
+
+/**
+ * Decides whether the token is still valid based on its expiration time.
+ * @param token The token to check.
+ * @return boolean indicating if the token is still valid.
+ */
+export function isTokenStillValid(token: string): boolean {
+  const decodedToken = jose.decodeJwt(token);
+
+  if (!decodedToken.exp) {
+    return false;
+  }
+
+  return new Date(decodedToken.exp * 1000) > new Date();
+}
+
+/**
+ * Initiates user authentication and handles token storage.
+ * @return The new token as a string.
+ */
+async function authenticateUser(): Promise<string> {
+  const token = await getPersonalAccessTokenFromWebsocket();
+  await saveToken(token);
+  return token;
+}
+
+function subscribeToWsEvents(sessionKey: string): Promise<string> {
+  return new Promise<string>((resolve, reject) => {
+    const socket = createSocket(ZEPHYR_API_ENDPOINT);
+
+    const cleanup = () => disposeSocket(socket);
+
+    socket.on('connect', () => {
+      // console.debug('WS Connected');
+    });
+
+    socket.on('disconnect', () => cleanup());
+
+    const roomSocket = socket.emit('joinAccessTokenRoom', {
+      state: sessionKey,
+    });
+
+    roomSocket.on('access-token', (token) => {
+      cleanup();
+      resolve(token);
+    });
+
+    roomSocket.on('access-token-error', (msg) => {
+      console.error('ERROR:', msg);
+      cleanup();
+      reject(new Error(msg));
+    });
+  });
+}

package/src/lib/utils/websocket.ts

@@ -0,0 +1,21 @@
+import { io as socketio, Socket } from 'socket.io-client';
+
+interface ClientToServerEvents {
+  joinAccessTokenRoom: (props: { state: string }) => void;
+}
+
+interface ServerToClientEvents {
+  'access-token': (token: string) => void;
+  'access-token-error': (msg: string) => void;
+}
+
+export function createSocket(
+  endpoint: string,
+): Socket<ServerToClientEvents, ClientToServerEvents> {
+  return socketio(endpoint);
+}
+
+export function disposeSocket(socket: Socket): void {
+  socket.disconnect();
+  socket.close();
+}

package/src/lib/ze-api/app-list.ts

@@ -0,0 +1,6 @@
+export interface ZeApplicationList {
+  list: { name: string; url: string }[];
+  origin: string;
+  domain: string;
+  cursor: string;
+}

package/src/lib/ze-api/app-version.ts

@@ -0,0 +1,25 @@
+export interface ZeAppVersion {
+  application_uid: string;
+  snapshot_id: string;
+  // npm-like version
+  version: string;
+
+  remote_entry_url: string;
+  remote_host: string;
+
+  // application name
+  name: string;
+  // tag name
+  tag?: string;
+  // env name
+  env?: string;
+
+  createdAt: string;
+  author: string;
+}
+
+// api: app_version response type
+export interface ZeAppVersionResponse extends ZeAppVersion {
+  // remote versions resolved at build time (versions) or read time (tags, envs)
+  remotes?: ZeAppVersion[];
+}

package/src/lib/zephyr-edge-contract.ts

@@ -0,0 +1,37 @@
+import { Asset } from 'webpack';
+
+export type Source = Asset['source'];
+
+export interface UploadableAsset {
+  path: string;
+  extname: string;
+  hash: string;
+  size: number;
+  buffer: Buffer | string;
+}
+
+export interface ZeUploadAssetsOptions {
+  missingAssets: SnapshotUploadRes | undefined;
+  count: number;
+  assetsMap: {
+    [key: string]: ZeBuildAsset;
+  };
+}
+
+export interface ZeBuildAsset {
+  path: string;
+  extname: string;
+  hash: string;
+  size: number;
+  buffer: Buffer | string;
+}
+
+export interface ZeBuildAssetsMap {
+  [key: string]: ZeBuildAsset;
+}
+
+export interface SnapshotUploadRes {
+  id: string;
+  assets: ZeBuildAsset[];
+  message: string;
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}

package/src/index.d.ts

@@ -1,12 +0,0 @@
-export { createFullAppName } from './lib/utils/create-full-app-name';
-export { createSnapshotId } from './lib/utils/create-snapshot-id';
-export { ZeAppVersion, ZeAppVersionResponse } from './lib/ze-api/app-version';
-export { ZeApplicationList } from './lib/ze-api/app-list';
-export { Snapshot, SnapshotAsset } from './lib/snapshot';
-export { ZeEnvs, ZeUploadBuildStats } from './lib/edge-api/ze-envs-request';
-export * from './lib/zephyr-edge-contract';
-export { type GetPersonalAccessTokenFromWebsocketOptions, type AuthOptions, getPersonalAccessTokenFromWebsocket, getAuthenticationURL, checkAuth, isTokenStillValid, } from './lib/utils/login';
-export { saveToken, getToken, removeToken } from './lib/node-persist/token';
-export { ZEPHYR_API_ENDPOINT, v2_api_paths, } from './lib/api-contract-negotiation/get-api-contract';
-export { getApplicationConfiguration } from './lib/utils/get-application-configuration';
-export { ZeApplicationConfig, getAppConfig, remoteAppConfig, saveAppConfig, } from './lib/node-persist/application-configuration';