@hawk.so/types 0.3.0 → 0.4.1

package/build/index.d.ts

@@ -1,32 +1,34 @@
-export * from "./src/auth/tokensPair";
-export * from "./src/base/businessOperation/businessOperation";
-export * from "./src/billing/planProlongrationPayload";
-export * from "./src/base/event/affectedUser";
-export * from "./src/base/event/backtraceFrame";
-export * from "./src/base/event/breadcrumb";
-export * from "./src/base/event/event";
-export * from "./src/base/event/sourceCodeLine";
-export * from "./src/base/event/addons";
-export * from "./src/base/integrations/integrationToken";
-export * from "./src/dbScheme/businessOperation";
-export * from "./src/dbScheme/groupedEvent";
-export * from "./src/dbScheme/notificationsChannels";
-export * from "./src/dbScheme/notificationsChannelSettings";
-export * from "./src/dbScheme/membership";
-export * from "./src/dbScheme/plan";
-export * from "./src/dbScheme/project";
-export * from "./src/dbScheme/projectNotificationsRule";
-export * from "./src/dbScheme/release";
-export * from "./src/dbScheme/repetition";
-export * from "./src/dbScheme/sourceMap";
-export * from "./src/dbScheme/user";
-export * from "./src/dbScheme/userNotifications";
-export * from "./src/dbScheme/workspace";
-export * from "./src/dbScheme/bankCard";
-export * from "./src/dbScheme/projectEventGroupingPattern";
-export * from "./src/notifications/createProjectNotifications";
-export * from "./src/notifications/receiveTypes";
-export * from "./src/notifications/updateProjectNotifications";
-export * from "./src/notifications/userNotification";
-export * from "./src/catchers/catcher-message";
-export * from './src/utils';
+export type * from './src/auth/tokensPair';
+export type * from './src/base/businessOperation/businessOperation';
+export type * from './src/billing/planProlongrationPayload';
+export type * from './src/base/event/affectedUser';
+export type * from './src/base/event/backtraceFrame';
+export type * from './src/base/event/breadcrumb';
+export type * from './src/base/event/event';
+export type * from './src/base/event/sourceCodeLine';
+export type * from './src/base/event/addons';
+export type * from './src/base/integrations/integrationToken';
+export type * from './src/dbScheme/businessOperation';
+export type * from './src/dbScheme/groupedEvent';
+export type * from './src/dbScheme/notificationsChannels';
+export type * from './src/dbScheme/notificationsChannelSettings';
+export type * from './src/dbScheme/membership';
+export type * from './src/dbScheme/userProjectsLastVisit';
+export type * from './src/dbScheme/plan';
+export type * from './src/dbScheme/project';
+export type * from './src/dbScheme/projectNotificationsRule';
+export type * from './src/dbScheme/release';
+export type * from './src/dbScheme/repetition';
+export type * from './src/dbScheme/sourceMap';
+export type * from './src/dbScheme/user';
+export type * from './src/dbScheme/userNotifications';
+export type * from './src/dbScheme/workspace';
+export type * from './src/dbScheme/bankCard';
+export type * from './src/dbScheme/sso';
+export type * from './src/dbScheme/projectEventGroupingPattern';
+export type * from './src/notifications/createProjectNotifications';
+export type * from './src/notifications/receiveTypes';
+export type * from './src/notifications/updateProjectNotifications';
+export type * from './src/notifications/userNotification';
+export type * from './src/catchers/catcher-message';
+export type * from './src/utils';

package/build/index.js

@@ -1,48 +1,2 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./src/auth/tokensPair"), exports);
-__exportStar(require("./src/base/businessOperation/businessOperation"), exports);
-__exportStar(require("./src/billing/planProlongrationPayload"), exports);
-__exportStar(require("./src/base/event/affectedUser"), exports);
-__exportStar(require("./src/base/event/backtraceFrame"), exports);
-__exportStar(require("./src/base/event/breadcrumb"), exports);
-__exportStar(require("./src/base/event/event"), exports);
-__exportStar(require("./src/base/event/sourceCodeLine"), exports);
-__exportStar(require("./src/base/event/addons"), exports);
-__exportStar(require("./src/base/integrations/integrationToken"), exports);
-__exportStar(require("./src/dbScheme/businessOperation"), exports);
-__exportStar(require("./src/dbScheme/groupedEvent"), exports);
-__exportStar(require("./src/dbScheme/notificationsChannels"), exports);
-__exportStar(require("./src/dbScheme/notificationsChannelSettings"), exports);
-__exportStar(require("./src/dbScheme/membership"), exports);
-__exportStar(require("./src/dbScheme/plan"), exports);
-__exportStar(require("./src/dbScheme/project"), exports);
-__exportStar(require("./src/dbScheme/projectNotificationsRule"), exports);
-__exportStar(require("./src/dbScheme/release"), exports);
-__exportStar(require("./src/dbScheme/repetition"), exports);
-__exportStar(require("./src/dbScheme/sourceMap"), exports);
-__exportStar(require("./src/dbScheme/user"), exports);
-__exportStar(require("./src/dbScheme/userNotifications"), exports);
-__exportStar(require("./src/dbScheme/workspace"), exports);
-__exportStar(require("./src/dbScheme/bankCard"), exports);
-__exportStar(require("./src/dbScheme/projectEventGroupingPattern"), exports);
-__exportStar(require("./src/notifications/createProjectNotifications"), exports);
-__exportStar(require("./src/notifications/receiveTypes"), exports);
-__exportStar(require("./src/notifications/updateProjectNotifications"), exports);
-__exportStar(require("./src/notifications/userNotification"), exports);
-__exportStar(require("./src/catchers/catcher-message"), exports);
-__exportStar(require("./src/utils"), exports);

package/build/src/dbScheme/membership.d.ts

@@ -33,3 +33,13 @@ export interface PendingMemberDBScheme {
  * Represents full structure of team collection documents
  */
 export type MemberDBScheme = ConfirmedMemberDBScheme | PendingMemberDBScheme;
+/**
+ * User workspace membership info stored in user document
+ * Record of workspace IDs to membership data
+ */
+export type MembershipDBScheme = Record<string, {
+    /**
+     * Whether the user's membership is pending confirmation
+     */
+    isPending?: boolean;
+}>;

package/build/src/dbScheme/sso.d.ts

@@ -0,0 +1,77 @@
+/**
+ * SSO configuration types for database schema
+ */
+/**
+ * SAML attribute mapping configuration
+ */
+export interface SamlAttributeMapping {
+    /**
+     * Attribute name for email in SAML Assertion
+     * @example "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"
+     * to get email from XML like this:
+     *  <Attribute Name="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress">
+     *    <AttributeValue>alice@company.com</AttributeValue>
+     *  </Attribute>
+     */
+    email: string;
+    /**
+     * Attribute name for user name in SAML Assertion
+     */
+    name?: string;
+}
+/**
+ * SAML SSO configuration
+ */
+export interface SamlConfig {
+    /**
+     * IdP Entity ID.
+     * Used to validate "this response is intended for Hawk"
+     * @example "urn:hawk:tracker:saml"
+     */
+    idpEntityId: string;
+    /**
+     * SSO URL for redirecting user to IdP
+     * Used to redirect user to IdP for authentication
+     * @example "https://idp.example.com/sso"
+     */
+    ssoUrl: string;
+    /**
+     * X.509 certificate for signature verification
+     * @example "-----BEGIN CERTIFICATE-----\nMIIDYjCCAkqgAwIBAgI...END CERTIFICATE-----"
+     */
+    x509Cert: string;
+    /**
+     * Desired NameID format
+     * @example "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"
+     */
+    nameIdFormat?: string;
+    /**
+     * Attribute mapping configuration
+     * Used to extract user attributes from SAML Response
+     */
+    attributeMapping: SamlAttributeMapping;
+}
+/**
+ * SSO configuration for workspace
+ */
+export interface WorkspaceSsoConfig {
+    /**
+     * Is SSO enabled
+     */
+    enabled: boolean;
+    /**
+     * Is SSO enforced (only SSO login allowed)
+     * If true, login via email/password is not allowed
+     */
+    enforced: boolean;
+    /**
+     * SSO provider type
+     * Currently only SAML is supported. In future we can add other providers (OAuth 2, etc.)
+     */
+    type: 'saml';
+    /**
+     * SAML-specific configuration.
+     * Got from IdP metadata.
+     */
+    saml: SamlConfig;
+}

package/build/src/dbScheme/sso.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * SSO configuration types for database schema
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/src/dbScheme/user.d.ts

@@ -1,6 +1,8 @@
 import type { ObjectId } from 'bson';
 import type { UserNotificationsDBScheme } from '../../index.ts';
 import type { BankCard } from './bankCard.ts';
+import type { MembershipDBScheme } from './membership.ts';
+import type { UserProjectsLastVisitDBScheme } from './userProjectsLastVisit.ts';
 /**
  * Interface representing how user is stored in DB
  */
@@ -29,6 +31,11 @@ export interface UserDBScheme {
      * User's GitHub profile id
      */
     githubId?: string;
+    /**
+     * User's workspaces membership
+     * Record of workspace IDs to membership data
+     */
+    workspaces?: MembershipDBScheme;
     /**
      * User's original password (this field appears only after registration).
      * Using to send password to user after registration
@@ -38,6 +45,10 @@ export interface UserDBScheme {
      * User notifications settings
      */
     notifications?: UserNotificationsDBScheme;
+    /**
+     * User's last visit timestamps for projects
+     */
+    projectsLastVisit?: UserProjectsLastVisitDBScheme;
     /**
      * Saved bank cards for one-click payments
      */
@@ -67,4 +78,24 @@ export interface UserDBScheme {
          */
         term?: string;
     };
+    /**
+     * External identities for SSO (keyed by workspaceId)
+     */
+    identities?: {
+        [workspaceId: string]: {
+            /**
+             * SAML-mode params
+             */
+            saml: {
+                /**
+                 * NameID value from IdP (stable identifier)
+                 */
+                id: string;
+                /**
+                 * Email at the time of linking (for audit)
+                 */
+                email: string;
+            };
+        };
+    };
 }

package/build/src/dbScheme/userProjectsLastVisit.d.ts

@@ -0,0 +1,5 @@
+/**
+ * User's last visit timestamps for projects
+ * Record of project IDs to Unix timestamps
+ */
+export type UserProjectsLastVisitDBScheme = Record<string, number>;

package/build/src/dbScheme/userProjectsLastVisit.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/src/dbScheme/workspace.d.ts

@@ -1,4 +1,5 @@
 import type { ObjectId } from 'bson';
+import type { WorkspaceSsoConfig } from './sso.ts';
 /**
  * Workspace representation in DataBase
  */
@@ -68,4 +69,8 @@ export interface WorkspaceDBScheme {
     lastNotificationDate?: {
         [key: string]: Date;
     };
+    /**
+     * SSO configuration (optional, only for workspaces with SSO enabled)
+     */
+    sso?: WorkspaceSsoConfig;
 }

package/index.ts

@@ -1,40 +1,42 @@
-export * from "./src/auth/tokensPair";
-
-export * from "./src/base/businessOperation/businessOperation";
-
-export * from "./src/billing/planProlongrationPayload";
-
-export * from "./src/base/event/affectedUser";
-export * from "./src/base/event/backtraceFrame";
-export * from "./src/base/event/breadcrumb";
-export * from "./src/base/event/event";
-export * from "./src/base/event/sourceCodeLine";
-export * from "./src/base/event/addons";
-
-export * from "./src/base/integrations/integrationToken";
-
-export * from "./src/dbScheme/businessOperation";
-export * from "./src/dbScheme/groupedEvent";
-export * from "./src/dbScheme/notificationsChannels";
-export * from "./src/dbScheme/notificationsChannelSettings";
-export * from "./src/dbScheme/membership";
-export * from "./src/dbScheme/plan";
-export * from "./src/dbScheme/project";
-export * from "./src/dbScheme/projectNotificationsRule";
-export * from "./src/dbScheme/release";
-export * from "./src/dbScheme/repetition";
-export * from "./src/dbScheme/sourceMap";
-export * from "./src/dbScheme/user";
-export * from "./src/dbScheme/userNotifications";
-export * from "./src/dbScheme/workspace";
-export * from "./src/dbScheme/bankCard";
-export * from "./src/dbScheme/projectEventGroupingPattern";
-
-export * from "./src/notifications/createProjectNotifications";
-export * from "./src/notifications/receiveTypes";
-export * from "./src/notifications/updateProjectNotifications";
-export * from "./src/notifications/userNotification";
-
-export * from "./src/catchers/catcher-message";
-
-export * from './src/utils';
+export type * from './src/auth/tokensPair';
+
+export type * from './src/base/businessOperation/businessOperation';
+
+export type * from './src/billing/planProlongrationPayload';
+
+export type * from './src/base/event/affectedUser';
+export type * from './src/base/event/backtraceFrame';
+export type * from './src/base/event/breadcrumb';
+export type * from './src/base/event/event';
+export type * from './src/base/event/sourceCodeLine';
+export type * from './src/base/event/addons';
+
+export type * from './src/base/integrations/integrationToken';
+
+export type * from './src/dbScheme/businessOperation';
+export type * from './src/dbScheme/groupedEvent';
+export type * from './src/dbScheme/notificationsChannels';
+export type * from './src/dbScheme/notificationsChannelSettings';
+export type * from './src/dbScheme/membership';
+export type * from './src/dbScheme/userProjectsLastVisit';
+export type * from './src/dbScheme/plan';
+export type * from './src/dbScheme/project';
+export type * from './src/dbScheme/projectNotificationsRule';
+export type * from './src/dbScheme/release';
+export type * from './src/dbScheme/repetition';
+export type * from './src/dbScheme/sourceMap';
+export type * from './src/dbScheme/user';
+export type * from './src/dbScheme/userNotifications';
+export type * from './src/dbScheme/workspace';
+export type * from './src/dbScheme/bankCard';
+export type * from './src/dbScheme/sso';
+export type * from './src/dbScheme/projectEventGroupingPattern';
+
+export type * from './src/notifications/createProjectNotifications';
+export type * from './src/notifications/receiveTypes';
+export type * from './src/notifications/updateProjectNotifications';
+export type * from './src/notifications/userNotification';
+
+export type * from './src/catchers/catcher-message';
+
+export type * from './src/utils';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hawk.so/types",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "TypeScript definitions for Hawk",
   "types": "build/index.d.ts",
   "main": "build/index.js",

package/src/dbScheme/membership.ts

@@ -39,3 +39,14 @@ export interface PendingMemberDBScheme {
  * Represents full structure of team collection documents
  */
 export type MemberDBScheme = ConfirmedMemberDBScheme | PendingMemberDBScheme;
+
+/**
+ * User workspace membership info stored in user document
+ * Record of workspace IDs to membership data
+ */
+export type MembershipDBScheme = Record<string, {
+  /**
+   * Whether the user's membership is pending confirmation
+   */
+  isPending?: boolean;
+}>;

package/src/dbScheme/sso.ts

@@ -0,0 +1,88 @@
+/**
+ * SSO configuration types for database schema
+ */
+
+/**
+ * SAML attribute mapping configuration
+ */
+export interface SamlAttributeMapping {
+  /**
+   * Attribute name for email in SAML Assertion
+   * @example "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"
+   * to get email from XML like this:
+   *  <Attribute Name="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress">
+   *    <AttributeValue>alice@company.com</AttributeValue>
+   *  </Attribute>
+   */
+  email: string;
+
+  /**
+   * Attribute name for user name in SAML Assertion
+   */
+  name?: string;
+}
+
+/**
+ * SAML SSO configuration
+ */
+export interface SamlConfig {
+  /**
+   * IdP Entity ID.
+   * Used to validate "this response is intended for Hawk"
+   * @example "urn:hawk:tracker:saml"
+   */
+  idpEntityId: string;
+
+  /**
+   * SSO URL for redirecting user to IdP
+   * Used to redirect user to IdP for authentication
+   * @example "https://idp.example.com/sso"
+   */
+  ssoUrl: string;
+
+  /**
+   * X.509 certificate for signature verification
+   * @example "-----BEGIN CERTIFICATE-----\nMIIDYjCCAkqgAwIBAgI...END CERTIFICATE-----"
+   */
+  x509Cert: string;
+
+  /**
+   * Desired NameID format
+   * @example "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"
+   */
+  nameIdFormat?: string;
+
+  /**
+   * Attribute mapping configuration
+   * Used to extract user attributes from SAML Response
+   */
+  attributeMapping: SamlAttributeMapping;
+}
+
+/**
+ * SSO configuration for workspace
+ */
+export interface WorkspaceSsoConfig {
+  /**
+   * Is SSO enabled
+   */
+  enabled: boolean;
+
+  /**
+   * Is SSO enforced (only SSO login allowed)
+   * If true, login via email/password is not allowed
+   */
+  enforced: boolean;
+
+  /**
+   * SSO provider type
+   * Currently only SAML is supported. In future we can add other providers (OAuth 2, etc.)
+   */
+  type: 'saml';
+
+  /**
+   * SAML-specific configuration.
+   * Got from IdP metadata.
+   */
+  saml: SamlConfig;
+}

package/src/dbScheme/user.ts

@@ -1,6 +1,8 @@
 import type { ObjectId } from 'bson';
 import type { UserNotificationsDBScheme } from '../../index.ts';
 import type { BankCard } from './bankCard.ts';
+import type { MembershipDBScheme } from './membership.ts';
+import type { UserProjectsLastVisitDBScheme } from './userProjectsLastVisit.ts';
 
 /**
  * Interface representing how user is stored in DB
@@ -36,6 +38,12 @@ export interface UserDBScheme {
    */
   githubId?: string;
 
+  /**
+   * User's workspaces membership
+   * Record of workspace IDs to membership data
+   */
+  workspaces?: MembershipDBScheme;
+
   /**
    * User's original password (this field appears only after registration).
    * Using to send password to user after registration
@@ -47,6 +55,11 @@ export interface UserDBScheme {
    */
   notifications?: UserNotificationsDBScheme;
 
+  /**
+   * User's last visit timestamps for projects
+   */
+  projectsLastVisit?: UserProjectsLastVisitDBScheme;
+
   /**
    * Saved bank cards for one-click payments
    */
@@ -81,4 +94,26 @@ export interface UserDBScheme {
      */
     term?: string;
   };
+
+  /**
+   * External identities for SSO (keyed by workspaceId)
+   */
+  identities?: {
+    [workspaceId: string]: {
+      /**
+       * SAML-mode params
+       */
+      saml: {
+        /**
+         * NameID value from IdP (stable identifier)
+         */
+        id: string;
+
+        /**
+         * Email at the time of linking (for audit)
+         */
+        email: string;
+      };
+    };
+  };
 }

package/src/dbScheme/userProjectsLastVisit.ts

@@ -0,0 +1,5 @@
+/**
+ * User's last visit timestamps for projects
+ * Record of project IDs to Unix timestamps
+ */
+export type UserProjectsLastVisitDBScheme = Record<string, number>;

package/src/dbScheme/workspace.ts

@@ -1,4 +1,5 @@
 import type { ObjectId } from 'bson';
+import type { WorkspaceSsoConfig } from './sso.ts';
 
 /**
  * Workspace representation in DataBase
@@ -81,4 +82,9 @@ export interface WorkspaceDBScheme {
    * Used to reduce frequency of some system messages
    */
   lastNotificationDate?: { [key: string]: Date };
+
+  /**
+   * SSO configuration (optional, only for workspaces with SSO enabled)
+   */
+  sso?: WorkspaceSsoConfig;
 }