@abyss-project/tools 1.0.5 → 1.2.0

package/src/types/interface/models/memo.dto.ts

@@ -1,23 +1,23 @@
-import { IOrganization } from './organization.dto';
-import { IProject } from './project.dto';
-import { IEntityTag } from './tag.dto';
-import { IUser } from './user.dto';
-
-export interface IMemo {
-  id: string;
-  title: string;
-  content: string;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  createdByUserId: string | null;
-  archivedAt?: Date | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  entityTags?: IEntityTag[];
-}
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IEntityTag } from './tag.dto';
+import { IUser } from './user.dto';
+
+export interface IMemo {
+  id: string;
+  title: string;
+  content: string;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  archivedAt?: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  entityTags?: IEntityTag[];
+}

package/src/types/interface/models/organization.dto.ts

@@ -1,12 +1,21 @@
-import { IProject } from './project.dto';
-
-export interface IOrganization {
-  id?: string;
-  name: string;
-  slug: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Associations
-  projects?: IProject[];
-}
+import { IProject } from './project.dto';
+
+export interface IOrganization {
+  id?: string;
+  name: string;
+  slug: string;
+  // Mirror of abyss-main Organization.kind. Drives the family default-share
+  // permission (family → EDIT, else VIEW). Synced by organization.middleware.ts.
+  // Typed as a literal union that mirrors @abyss-project/main's OrganizationKind
+  // enum values 1:1 — this published SDK package intentionally does NOT depend on
+  // @abyss-project/main, so the enum is referenced by value (the api-side model
+  // and middleware narrow this to OrganizationKind, where main IS resolvable).
+  kind?: 'standard' | 'family';
+  // Last refresh of `kind` from abyss-main; drives the TTL (≤5min) sync gate.
+  kindSyncedAt?: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  projects?: IProject[];
+}

package/src/types/interface/models/project.dto.ts

@@ -1,25 +1,25 @@
-import { IAtlas } from './atlas.dto';
-import { IDraw } from './draw.dto';
-import { IMemo } from './memo.dto';
-import { IOrganization } from './organization.dto';
-import { IRetrospective } from './retrospective.dto';
-import { IShortLink } from './short-link.dto';
-import { IUser } from './user.dto';
-
-export interface IProject {
-  id?: string;
-  name: string;
-  createdByUserId: string; // Historical creator of the project. NOT used for access control.
-  organizationId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Associations
-  organization?: IOrganization;
-  user?: IUser;
-  draws?: IDraw[];
-  retrospectives?: IRetrospective[];
-  atlases?: IAtlas[];
-  memos?: IMemo[];
-  shortLinks?: IShortLink[];
-}
+import { IAtlas } from './atlas.dto';
+import { IDraw } from './draw.dto';
+import { IMemo } from './memo.dto';
+import { IOrganization } from './organization.dto';
+import { IRetrospective } from './retrospective.dto';
+import { IShortLink } from './short-link.dto';
+import { IUser } from './user.dto';
+
+export interface IProject {
+  id?: string;
+  name: string;
+  createdByUserId: string; // Historical creator of the project. NOT used for access control.
+  organizationId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  organization?: IOrganization;
+  user?: IUser;
+  draws?: IDraw[];
+  retrospectives?: IRetrospective[];
+  atlases?: IAtlas[];
+  memos?: IMemo[];
+  shortLinks?: IShortLink[];
+}

package/src/types/interface/models/retrospective-card.dto.ts

@@ -1,17 +1,17 @@
-import { IRetrospectiveMember } from './retrospective-member.dto';
-import { IRetrospective } from './retrospective.dto';
-
-export interface IRetrospectiveCard {
-  id: string;
-  content: string;
-  positionX: number;
-  positionY: number;
-  retrospectiveId: string;
-  retrospectiveMemberId?: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  retrospective?: IRetrospective;
-  retrospectiveMember?: IRetrospectiveMember;
-}
+import { IRetrospectiveMember } from './retrospective-member.dto';
+import { IRetrospective } from './retrospective.dto';
+
+export interface IRetrospectiveCard {
+  id: string;
+  content: string;
+  positionX: number;
+  positionY: number;
+  retrospectiveId: string;
+  retrospectiveMemberId?: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  retrospective?: IRetrospective;
+  retrospectiveMember?: IRetrospectiveMember;
+}

package/src/types/interface/models/retrospective-member.dto.ts

@@ -1,15 +1,15 @@
-import { IRetrospective } from './retrospective.dto';
-
-export interface IRetrospectiveMember {
-  id: string;
-  alias: string | null;
-  userId: string | null;
-  externalUserId: string | null;
-  unmaskedAt: Date | null;
-  retrospectiveId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  retrospective?: IRetrospective;
-}
+import { IRetrospective } from './retrospective.dto';
+
+export interface IRetrospectiveMember {
+  id: string;
+  alias: string | null;
+  userId: string | null;
+  externalUserId: string | null;
+  unmaskedAt: Date | null;
+  retrospectiveId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  retrospective?: IRetrospective;
+}

package/src/types/interface/models/retrospective-section.dto.ts

@@ -1,16 +1,16 @@
-import { IRetrospective } from './retrospective.dto';
-
-export interface IRetrospectiveSection {
-  id: string;
-  title: string;
-  description: string;
-  color: string;
-  positionX: number;
-  positionY: number;
-  retrospectiveId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  retrospective?: IRetrospective;
-}
+import { IRetrospective } from './retrospective.dto';
+
+export interface IRetrospectiveSection {
+  id: string;
+  title: string;
+  description: string;
+  color: string;
+  positionX: number;
+  positionY: number;
+  retrospectiveId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  retrospective?: IRetrospective;
+}

package/src/types/interface/models/retrospective.dto.ts

@@ -1,32 +1,32 @@
-import { IOrganization } from './organization.dto';
-import { IProject } from './project.dto';
-import { IRetrospectiveCard } from './retrospective-card.dto';
-import { IRetrospectiveMember } from './retrospective-member.dto';
-import { IRetrospectiveSection } from './retrospective-section.dto';
-import { IEntityTag } from './tag.dto';
-import { IUser } from './user.dto';
-
-export interface IRetrospective {
-  id: string;
-  title: string;
-  description: string;
-  startDate: Date | null;
-  endDate: Date | null;
-  completedAt: Date | null;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  createdByUserId: string | null;
-  archivedAt: Date | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  retrospectiveSections?: IRetrospectiveSection[];
-  retrospectiveCards?: IRetrospectiveCard[];
-  retrospectiveMembers?: IRetrospectiveMember[];
-  entityTags?: IEntityTag[];
-}
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IRetrospectiveCard } from './retrospective-card.dto';
+import { IRetrospectiveMember } from './retrospective-member.dto';
+import { IRetrospectiveSection } from './retrospective-section.dto';
+import { IEntityTag } from './tag.dto';
+import { IUser } from './user.dto';
+
+export interface IRetrospective {
+  id: string;
+  title: string;
+  description: string;
+  startDate: Date | null;
+  endDate: Date | null;
+  completedAt: Date | null;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  archivedAt: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  retrospectiveSections?: IRetrospectiveSection[];
+  retrospectiveCards?: IRetrospectiveCard[];
+  retrospectiveMembers?: IRetrospectiveMember[];
+  entityTags?: IEntityTag[];
+}

package/src/types/interface/models/short-link-click.dto.ts

@@ -1,33 +1,33 @@
-import { IShortLink } from './short-link.dto';
-
-export interface IShortLinkClick {
-  id: string;
-  shortLinkId: string;
-  ipAddress: string | null;
-  ipHash: string;
-  userAgent: string | null;
-  referer: string | null;
-  refererDomain: string | null;
-  /** Code pays ISO-3 (ex: "FRA", "USA", "DEU") */
-  countryCodeIso: string | null;
-  countryCode: string | null;
-  countryName: string | null;
-  continentCode: string | null;
-  city: string | null;
-  device: string | null;
-  browser: string | null;
-  os: string | null;
-  language: string | null;
-  utmSource: string | null;
-  utmMedium: string | null;
-  utmCampaign: string | null;
-  utmTerm: string | null;
-  utmContent: string | null;
-  isBotLikely: boolean;
-  isReturningVisitor: boolean;
-  clickedAt: Date;
-  createdAt?: Date;
-  updatedAt?: Date;
-
-  shortLink?: IShortLink;
-}
+import { IShortLink } from './short-link.dto';
+
+export interface IShortLinkClick {
+  id: string;
+  shortLinkId: string;
+  ipAddress: string | null;
+  ipHash: string;
+  userAgent: string | null;
+  referer: string | null;
+  refererDomain: string | null;
+  /** Code pays ISO-3 (ex: "FRA", "USA", "DEU") */
+  countryCodeIso: string | null;
+  countryCode: string | null;
+  countryName: string | null;
+  continentCode: string | null;
+  city: string | null;
+  device: string | null;
+  browser: string | null;
+  os: string | null;
+  language: string | null;
+  utmSource: string | null;
+  utmMedium: string | null;
+  utmCampaign: string | null;
+  utmTerm: string | null;
+  utmContent: string | null;
+  isBotLikely: boolean;
+  isReturningVisitor: boolean;
+  clickedAt: Date;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  shortLink?: IShortLink;
+}

package/src/types/interface/models/short-link.dto.ts

@@ -1,49 +1,49 @@
-import { IOrganization } from './organization.dto';
-import { IUser } from './user.dto';
-import { IProject } from './project.dto';
-import { IShortLinkClick } from './short-link-click.dto';
-import { IEntityTag } from './tag.dto';
-
-export interface IShortLink {
-  id: string;
-  slug: string;
-  originalUrl: string;
-  title: string | null;
-  description: string | null;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  createdByUserId: string | null;
-  isActive: boolean;
-  clickCount: number;
-  uniqueClickCount: number;
-  lastClickedAt: Date | null;
-  expiresAt: Date | null;
-  maxClicks: number | null;
-  password: string | null;
-  createdAt?: Date;
-  updatedAt?: Date;
-  deletedAt?: Date | null;
-
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  shortLinkClicks?: IShortLinkClick[];
-  entityTags?: IEntityTag[];
-}
-
-export interface IShortLinkWithStats extends IShortLink {
-  stats?: {
-    clicksByDay: { date: string; clicks: number; uniqueClicks: number }[];
-    clicksByCountry: { country: string; clicks: number; countryName: string }[];
-    clicksByDevice: { device: string; clicks: number }[];
-    clicksByBrowser: { browser: string; clicks: number }[];
-    clicksByReferer: { referer: string; clicks: number }[];
-    clicksByUtmSource: { utmSource: string; clicks: number }[];
-    clicksByLanguage: { language: string; clicks: number }[];
-    clicksByRefererDomain: { refererDomain: string; clicks: number }[];
-    clicksLast24h: number;
-    returningVisitorsCount: number;
-    botClicksCount: number;
-  };
-}
+import { IOrganization } from './organization.dto';
+import { IUser } from './user.dto';
+import { IProject } from './project.dto';
+import { IShortLinkClick } from './short-link-click.dto';
+import { IEntityTag } from './tag.dto';
+
+export interface IShortLink {
+  id: string;
+  slug: string;
+  originalUrl: string;
+  title: string | null;
+  description: string | null;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  isActive: boolean;
+  clickCount: number;
+  uniqueClickCount: number;
+  lastClickedAt: Date | null;
+  expiresAt: Date | null;
+  maxClicks: number | null;
+  password: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date | null;
+
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  shortLinkClicks?: IShortLinkClick[];
+  entityTags?: IEntityTag[];
+}
+
+export interface IShortLinkWithStats extends IShortLink {
+  stats?: {
+    clicksByDay: { date: string; clicks: number; uniqueClicks: number }[];
+    clicksByCountry: { country: string; clicks: number; countryName: string }[];
+    clicksByDevice: { device: string; clicks: number }[];
+    clicksByBrowser: { browser: string; clicks: number }[];
+    clicksByReferer: { referer: string; clicks: number }[];
+    clicksByUtmSource: { utmSource: string; clicks: number }[];
+    clicksByLanguage: { language: string; clicks: number }[];
+    clicksByRefererDomain: { refererDomain: string; clicks: number }[];
+    clicksLast24h: number;
+    returningVisitorsCount: number;
+    botClicksCount: number;
+  };
+}

package/src/types/interface/models/tag.dto.ts

@@ -1,26 +1,26 @@
-export interface ITag {
-  id: string;
-  name: string;
-  color: string;
-  userId: string;
-  organizationId: string | null;
-  createdAt?: Date;
-  updatedAt?: Date;
-}
-
-// Junction type for entity-tag relationships
-export interface IEntityTag {
-  id: string;
-  entityId: string;
-  entityType: string;
-  tagId: string;
-  createdAt?: Date;
-  tag?: ITag | null;
-}
-
-// Stats entry for tag usage counts
-export interface ITagStatEntry {
-  tagId: string;
-  entityType: string;
-  count: number;
-}
+export interface ITag {
+  id: string;
+  name: string;
+  color: string;
+  userId: string;
+  organizationId: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+// Junction type for entity-tag relationships
+export interface IEntityTag {
+  id: string;
+  entityId: string;
+  entityType: string;
+  tagId: string;
+  createdAt?: Date;
+  tag?: ITag | null;
+}
+
+// Stats entry for tag usage counts
+export interface ITagStatEntry {
+  tagId: string;
+  entityType: string;
+  count: number;
+}

package/src/types/interface/models/team.dto.ts

@@ -1,12 +1,12 @@
-import { IOrganization } from './organization.dto';
-
-export interface ITeam {
-  id?: string;
-  organizationId: string;
-  name: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Associations
-  organization?: IOrganization;
-}
+import { IOrganization } from './organization.dto';
+
+export interface ITeam {
+  id?: string;
+  organizationId: string;
+  name: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  organization?: IOrganization;
+}

package/src/types/interface/models/user.dto.ts

@@ -1,26 +1,26 @@
-import { IAtlas } from './atlas.dto';
-import { IBoard } from './board.dto';
-import { IBoardCardComment } from './board-card-comment.dto';
-import { IDraw } from './draw.dto';
-import { IMemo } from './memo.dto';
-import { IProject } from './project.dto';
-import { IRetrospective } from './retrospective.dto';
-import { IShortLink } from './short-link.dto';
-
-export interface IUser {
-  id?: string;
-  apiKey: string;
-  isAdmin: boolean;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Associations
-  projects?: IProject[];
-  boards?: IBoard[];
-  draws?: IDraw[];
-  retrospectives?: IRetrospective[];
-  atlases?: IAtlas[];
-  memos?: IMemo[];
-  shortLinks?: IShortLink[];
-  boardCardComments?: IBoardCardComment[];
-}
+import { IAtlas } from './atlas.dto';
+import { IBoard } from './board.dto';
+import { IBoardCardComment } from './board-card-comment.dto';
+import { IDraw } from './draw.dto';
+import { IMemo } from './memo.dto';
+import { IProject } from './project.dto';
+import { IRetrospective } from './retrospective.dto';
+import { IShortLink } from './short-link.dto';
+
+export interface IUser {
+  id?: string;
+  apiKey: string;
+  isAdmin: boolean;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  projects?: IProject[];
+  boards?: IBoard[];
+  draws?: IDraw[];
+  retrospectives?: IRetrospective[];
+  atlases?: IAtlas[];
+  memos?: IMemo[];
+  shortLinks?: IShortLink[];
+  boardCardComments?: IBoardCardComment[];
+}

package/src/types/tests/beam-management-types.spec.ts

@@ -0,0 +1,38 @@
+import type {
+  IRenewBeamParams,
+  IReactivateBeamParams,
+  ICreateBeamShareBody,
+  IRevokeBeamShareParams,
+} from '../interface/api/requests/beam.request';
+import type {
+  IRenewBeamResponse,
+  ICreateBeamShareResponse,
+  IListBeamSharesResponse,
+} from '../interface/api/responses/beam.response';
+import { ShareTargetType, SharePermission } from '../enum/content-share.enum';
+import { BEAM_MANAGE_TOKEN_HEADER } from '../../constants/beam.constants';
+
+describe('beam management SDK types', () => {
+  it('compiles renew/share request + response shapes', () => {
+    const renew: IRenewBeamParams = { beamId: 'b1' };
+    const reactivate: IReactivateBeamParams = { beamId: 'b1' };
+    const share: ICreateBeamShareBody = {
+      targetType: ShareTargetType.PROJECT,
+      targetId: 'p1',
+      permission: SharePermission.VIEW,
+    };
+    const revoke: IRevokeBeamShareParams = { beamId: 'b1', shareId: 's1' };
+    const renewResp: IRenewBeamResponse['data'] = { beamTransfer: {} as never };
+    const createResp: ICreateBeamShareResponse['data'] = { contentShare: {} as never };
+    const listResp: IListBeamSharesResponse['data'] = { contentShares: [] };
+
+    expect(renew.beamId).toBe('b1');
+    expect(reactivate.beamId).toBe('b1');
+    expect(share.targetType).toBe(ShareTargetType.PROJECT);
+    expect(revoke.shareId).toBe('s1');
+    expect(BEAM_MANAGE_TOKEN_HEADER).toBe('x-beam-manage-token');
+    expect(renewResp).toBeDefined();
+    expect(createResp).toBeDefined();
+    expect(listResp.contentShares).toHaveLength(0);
+  });
+});

package/src/types/tests/beam-share-enums.spec.ts

@@ -0,0 +1,11 @@
+import { ShareableContentType, ShareTargetType } from '../enum/content-share.enum';
+
+describe('tools content-share mirror — beam sharing members', () => {
+  it('exposes ShareableContentType.BEAM matching the abyss-main value', () => {
+    expect(ShareableContentType.BEAM).toBe('beam');
+  });
+
+  it('exposes ShareTargetType.PROJECT so beam RESTRICTED grants can target a project', () => {
+    expect(ShareTargetType.PROJECT).toBe('PROJECT');
+  });
+});