@superblocksteam/shared 0.9607.1 → 0.9607.3

package/dist-esm/utils/maskCredential.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maskCredential.js","sourceRoot":"","sources":["../../src/utils/maskCredential.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAE1C,wFAAwF;AACxF,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAE7C;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE;IACpD,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC;IACtD,OAAO,GAAG,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,0BAA0B,CAAC,EAAE,CAAC;AAC9D,CAAC,CAAC"}

package/dist-esm/utils/maskCredential.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=maskCredential.test.d.ts.map

package/dist-esm/utils/maskCredential.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maskCredential.test.d.ts","sourceRoot":"","sources":["../../src/utils/maskCredential.test.ts"],"names":[],"mappings":""}

package/dist-esm/utils/maskCredential.test.js

@@ -0,0 +1,14 @@
+import { describe, expect, it } from 'vitest';
+import { maskCredential } from './maskCredential.js';
+describe('maskCredential', () => {
+    it('shows the first 4 characters followed by asterisks', () => {
+        expect(maskCredential('abcdEFGHijklMNOP')).toBe('abcd**************');
+    });
+    it('masks a short key without exposing more than the prefix length', () => {
+        expect(maskCredential('ab')).toBe('ab**************');
+    });
+    it('returns only asterisks for an empty string', () => {
+        expect(maskCredential('')).toBe('**************');
+    });
+});
+//# sourceMappingURL=maskCredential.test.js.map

package/dist-esm/utils/maskCredential.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maskCredential.test.js","sourceRoot":"","sources":["../../src/utils/maskCredential.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/shared",
-  "version": "0.9607.1",
+  "version": "0.9607.3",
   "description": "Superblocks Shared Resources",
   "license": "Superblocks Community Software License",
   "repository": "https://github.com/superblocksteam/shared.git",

package/src/types/ai/index.ts

@@ -1,3 +1,5 @@
+import { DeploymentTypeEnum, RegionEnum } from '../common/index.js';
+
 export type AiChatMessagePayload = Record<string, unknown>;
 
 export type AiChatMessageDto = {
@@ -92,6 +94,9 @@ export interface AiWorkflowAttributes {
 export interface AiWorkflowEvent {
   promptId: string;
   attributes: AiWorkflowAttributes;
+  region?: RegionEnum;
+  deploymentType?: DeploymentTypeEnum;
+  deploymentName?: string;
 }
 
 /**

package/src/types/application/index.test.ts

@@ -1,6 +1,16 @@
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+
 import { describe, expect, it } from 'vitest';
 
-import { effectiveCommitTemplateName, isSdkApiCommitTemplate, isSdkApiTemplate, LEGACY_COMMIT_TEMPLATE_NAME } from './index';
+import {
+  ApplicationType,
+  effectiveCommitTemplateName,
+  getApplicationType,
+  isSdkApiCommitTemplate,
+  isSdkApiTemplate,
+  LEGACY_COMMIT_TEMPLATE_NAME
+} from './index';
 
 describe('SDK API application templates', () => {
   it('classifies app-fullstack as the 3.0 SDK API template', () => {
@@ -20,3 +30,76 @@ describe('SDK API application templates', () => {
     expect(effectiveCommitTemplateName(null)).toBe(LEGACY_COMMIT_TEMPLATE_NAME);
   });
 });
+
+describe('getApplicationType', () => {
+  it('classifies an application with devEnvEnabled=false as 1.0', () => {
+    expect(getApplicationType({ devEnvEnabled: false, templateName: null })).toBe(ApplicationType.V1);
+  });
+
+  it('classifies a legacy 1.0 application as 1.0 even when a template name is present', () => {
+    // devEnvEnabled is the 1.0 vs 2.0+ discriminator; template name alone never promotes a 1.0 app.
+    expect(getApplicationType({ devEnvEnabled: false, templateName: 'app-fullstack' })).toBe(ApplicationType.V1);
+  });
+
+  it.each([null, 'shadcn-demo-app', 'blank-app'])('classifies a code-mode application on template %s as 2.0', (templateName) => {
+    expect(getApplicationType({ devEnvEnabled: true, templateName })).toBe(ApplicationType.V2);
+  });
+
+  it('classifies a code-mode application on an SDK API template as 3.0', () => {
+    expect(getApplicationType({ devEnvEnabled: true, templateName: 'app-fullstack' })).toBe(ApplicationType.V3);
+  });
+
+  it.each([undefined, null])('returns undefined when devEnvEnabled was not projected (%s) by the query', (devEnvEnabled) => {
+    // dev_env_enabled is NOT NULL DEFAULT false, so a nullish value means unselected.
+    expect(getApplicationType({ devEnvEnabled, templateName: 'app-fullstack' })).toBeUndefined();
+  });
+
+  it('returns undefined when templateName was not projected for a code-mode app', () => {
+    // Guessing 2.0 here would silently misclassify every 3.0 app behind a partial select.
+    expect(getApplicationType({ devEnvEnabled: true })).toBeUndefined();
+  });
+
+  it('does not need templateName to classify a legacy app', () => {
+    expect(getApplicationType({ devEnvEnabled: false })).toBe(ApplicationType.V1);
+  });
+
+  it('treats a genuinely null template as a real value, not an unprojected one', () => {
+    expect(getApplicationType({ devEnvEnabled: true, templateName: null })).toBe(ApplicationType.V2);
+  });
+
+  it('does not classify from a commit-scoped template resolution', () => {
+    // A commit predating a 2.0 -> 3.0 migration resolves to the legacy template.
+    // Classifying off that instead of the app row is what would misreport 3.0 as 2.0.
+    const migratedAppRow = { devEnvEnabled: true, templateName: 'app-fullstack' };
+    const preMigrationCommitTemplate = effectiveCommitTemplateName(null);
+
+    expect(getApplicationType(migratedAppRow)).toBe(ApplicationType.V3);
+    expect(getApplicationType({ devEnvEnabled: true, templateName: preMigrationCommitTemplate })).toBe(ApplicationType.V2);
+  });
+
+  it('exposes the version strings the analytics pipeline filters on', () => {
+    expect(ApplicationType.V1).toBe('1.0');
+    expect(ApplicationType.V2).toBe('2.0');
+    expect(ApplicationType.V3).toBe('3.0');
+  });
+});
+
+describe('SDK_API_TEMPLATES stays in sync with the demo-apps template config', () => {
+  // isSdkApiTemplate drives the 3.0-vs-2.0 half of getApplicationType, which is a
+  // billing input. A new SDK API template shipped without updating the allowlist
+  // would not fail safe -- it would confidently classify those apps as 2.0. The
+  // template config is the source of truth, so pin the two together here rather
+  // than relying on the "must stay in sync" comment alone.
+  // This package compiles to CommonJS, so import.meta is unavailable; vitest runs
+  // with the package directory as cwd.
+  const configPath = resolve(process.cwd(), '../demo-apps/config.json');
+  const templates = (JSON.parse(readFileSync(configPath, 'utf8')) as { templates: Record<string, { sdkApi?: boolean }> }).templates;
+
+  it('has at least one template to check', () => {
+    expect(Object.keys(templates).length).toBeGreaterThan(0);
+  });
+
+  it.each(Object.entries(templates))('agrees with config.json on whether %s is an SDK API template', (name, template) => {
+    expect(isSdkApiTemplate(name)).toBe(template.sdkApi === true);
+  });
+});

package/src/types/application/index.ts

@@ -659,6 +659,56 @@ export function isSdkApiTemplate(templateName: string | null | undefined): boole
   return SDK_API_TEMPLATES.has(templateName);
 }
 
+/**
+ * The product generation an application belongs to, as reported to analytics and
+ * billing. The values are the customer-facing version labels so downstream
+ * consumers (Snowflake, billing) can filter on them directly.
+ */
+export enum ApplicationType {
+  /** Legacy drag-and-drop application (not code mode). */
+  V1 = '1.0',
+  /** Code-mode application on a non-SDK-API template. */
+  V2 = '2.0',
+  /** Code-mode application on an SDK API template. */
+  V3 = '3.0'
+}
+
+/**
+ * Classifies an application as 1.0 / 2.0 / 3.0 from the two fields that already
+ * live on the application row: `dev_env_enabled` separates legacy (1.0) from
+ * code-mode (2.0+), and the SDK API template separates 3.0 from 2.0. A 2.0 to
+ * 3.0 migration is a `template_name` flip on the same application row, so this
+ * classification follows the app across a migration with no extra lookup.
+ *
+ * Both inputs must come from the application ROW. In particular `templateName`
+ * must not be a commit's effective template (see `effectiveCommitTemplateName`):
+ * a commit predating a 2.0 to 3.0 migration resolves to the legacy template and
+ * would misreport a 3.0 app as 2.0.
+ *
+ * Returns `undefined` when the app cannot be classified because a field was not
+ * projected by the caller's query. `undefined` is distinguishable from a real
+ * `null` template (a legacy template, a valid 2.0 value), so an unselected
+ * column yields no answer instead of a confidently wrong one.
+ */
+export function getApplicationType(application: {
+  devEnvEnabled?: boolean | null;
+  templateName?: string | null;
+}): ApplicationType | undefined {
+  // `dev_env_enabled` is NOT NULL DEFAULT false, so a nullish value here means
+  // the column was not selected rather than a legitimate absence.
+  if (application.devEnvEnabled == null) {
+    return undefined;
+  }
+  if (!application.devEnvEnabled) {
+    return ApplicationType.V1;
+  }
+  // `template_name` IS nullable, so only `undefined` means "not projected".
+  if (application.templateName === undefined) {
+    return undefined;
+  }
+  return isSdkApiTemplate(application.templateName) ? ApplicationType.V3 : ApplicationType.V2;
+}
+
 /**
  * The legacy template name that commits predating the per-commit `template_name`
  * column are treated as. NULL on `application_commit.template_name` means the

package/src/types/event/index.ts

@@ -1,4 +1,5 @@
-import { RegionEnum } from '../common/index.js';
+import { type ApplicationType } from '../application/index.js';
+import { DeploymentTypeEnum, RegionEnum } from '../common/index.js';
 import { RequestSource } from '../user/index.js';
 
 export enum EventEntityType {
@@ -18,6 +19,7 @@ export enum EventEntityType {
   SURVEY = 'survey',
   ACCOUNT = 'account',
   BILLING = 'billing',
+  BUILDER_LICENSE = 'builder_license',
   OBSERVABILITY = 'observability',
   GROUP = 'group',
   ORGANIZATION_INVITES = 'organization_invites',
@@ -71,15 +73,18 @@ export enum EventAction {
   DEPLOYED = 'deployed',
   UNDEPLOYED = 'undeployed',
   IMPORTED = 'imported',
+  MIGRATED = 'migrated',
   EXECUTED = 'executed',
   EXPORTED = 'exported',
   VIEWED = 'viewed',
   STARTED = 'started',
   FINISHED = 'finished',
   ADDED = 'added',
+  ASSIGNED = 'assigned',
   PAUSED = 'paused',
   RESUMED = 'resumed',
   UPDATED = 'updated',
+  UNASSIGNED = 'unassigned',
   PATCHED = 'patched',
   METADATA_UPDATED = 'metadata_updated',
   SETTINGS_UPDATED = 'settings_updated',
@@ -124,12 +129,29 @@ export interface UserEvent {
   properties?: Record<string, any>;
   createdAt: Date;
   region?: RegionEnum;
+  deploymentType?: DeploymentTypeEnum;
+  deploymentName?: string;
   source?: RequestSource;
 }
 
 export interface EventEntity {
   id: string;
   name: string | undefined;
+  /**
+   * Product generation (1.0 / 2.0 / 3.0), stamped onto `* application` events.
+   *
+   * Populated only by `applicationEventEntity()`, which classifies from the
+   * application row. No `ApplicationV2` or `ApplicationV2Dto` carries a field of
+   * this name, so passing one of those directly leaves it unset rather than
+   * supplying a value of unknown grain -- but note that is a naming convention,
+   * not something the type system enforces: `newEvent` accepts any `EventEntity`,
+   * so a future field with this name would be picked up structurally.
+   *
+   * Left undefined whenever the caller cannot classify the app (only an id in
+   * hand, or a query that did not project the needed columns). An absent property
+   * beats a guessed one -- a wrong generation is worse for billing than none.
+   */
+  applicationType?: ApplicationType;
 }
 
 export enum EventSource {

package/src/types/organization/agent.ts

@@ -44,7 +44,8 @@ export enum AgentsHealthStatus {
 
 export type Agent = {
   id: string;
-  key: string;
+  /** Registration key; omitted on ordinary API reads (SEC-43). */
+  key?: string;
   environment: string;
   status: AgentStatus;
   version: string;

package/src/types/organization/index.ts

@@ -44,7 +44,8 @@ export interface Organization {
   name: string;
   domains?: Domain[];
   agents?: Agent[];
-  apiKey: string;
+  /** Live ORG_USER key; omitted on ordinary reads (SEC-43). Use execution-token endpoints. */
+  apiKey?: string;
   agentType: AgentType;
   minExternalAgentVersion: string;
   pluginExecutionVersions?: PluginExecutionVersions;

package/src/utils/index.ts

@@ -1,18 +1,19 @@
-export * from './configuration.js';
-export * from './attachment-upload.js';
+export * from './apiv2.js';
 export * from './attachment-delivery.js';
+export * from './attachment-upload.js';
+export * from './bytestring.js';
+export * from './configuration.js';
 export * from './env.js';
 export * from './environment.js';
 export * from './git-url.js';
+export * from './maskCredential.js';
+export * from './normalize.js';
+export * from './normalizeRoleName.js';
+export * from './page.js';
 export * from './string.js';
 export * from './time.js';
 export * from './truncate.js';
 export * from './url.js';
-export * from './bytestring.js';
-export * from './apiv2.js';
-export * from './page.js';
-export * from './normalize.js';
-export * from './normalizeRoleName.js';
 
 import gridV4 from './pageFixtures/v4/grid.js';
 export { gridV4 };

package/src/utils/maskCredential.test.ts

@@ -0,0 +1,17 @@
+import { describe, expect, it } from 'vitest';
+
+import { maskCredential } from './maskCredential.js';
+
+describe('maskCredential', () => {
+  it('shows the first 4 characters followed by asterisks', () => {
+    expect(maskCredential('abcdEFGHijklMNOP')).toBe('abcd**************');
+  });
+
+  it('masks a short key without exposing more than the prefix length', () => {
+    expect(maskCredential('ab')).toBe('ab**************');
+  });
+
+  it('returns only asterisks for an empty string', () => {
+    expect(maskCredential('')).toBe('**************');
+  });
+});

package/src/utils/maskCredential.ts

@@ -0,0 +1,14 @@
+/** Number of leading characters shown for identification on credential display surfaces. */
+export const CREDENTIAL_PREFIX_LENGTH = 4;
+
+/** Fixed asterisk pad length for masked credentials (does not encode secret length). */
+export const CREDENTIAL_MASK_PAD_LENGTH = 14;
+
+/**
+ * Mask a credential for UI display: first {@link CREDENTIAL_PREFIX_LENGTH} characters
+ * plus a fixed asterisk pad. The full secret must never be returned on ordinary reads.
+ */
+export const maskCredential = (key: string): string => {
+  const prefix = key.slice(0, CREDENTIAL_PREFIX_LENGTH);
+  return `${prefix}${'*'.repeat(CREDENTIAL_MASK_PAD_LENGTH)}`;
+};