@newgameplusinc/odyssey-organization-sdk 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,341 @@
+/**
+ * Shared primitive types and SDK config used across all modules.
+ */
+type OrganizationSDKConfig = {
+    apiKey: string;
+    timeout?: number;
+};
+type PaginationQuery = {
+    page?: number;
+    limit?: number;
+};
+type PaginationMeta = {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+};
+type InviteStatus = "PENDING" | "ACCEPTED" | "REJECTED" | "EXPIRES";
+type InviteType = "EMAIL" | "LINK";
+type OdysseyMobileControls = "ON" | "OFF" | "JOYSTICK_ONLY";
+type AvatarType = "STANDARD" | "AEC";
+type AvatarControlSystem = "EVENT_MODE" | "GAME_MODE" | "FLIGHT_MODE";
+type HealthResponse = {
+    status: string;
+    timestamp: string;
+};
+type RedisHealthResponse = {
+    status: string;
+    latencyMs?: number;
+};
+
+type Organization = {
+    id: string;
+    name: string;
+    domain: string;
+    logoSmallUrl: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type OrganizationUser = {
+    id: string;
+    orgId: string;
+    email: string;
+    roleId: string;
+    avatarReadyPlayerMeImg: string | null;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type OrganizationConfiguration = {
+    id: string;
+    orgId: string;
+    unrealImageId: string;
+    unrealImageRepo: string;
+    workloadClusterProvider: string;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type CreateOrganizationInput = {
+    name: string;
+};
+type UpdateOrganizationInput = {
+    name?: string | null;
+    domain?: string | null;
+    logoSmallUrl?: string | null;
+};
+type OrganizationListResult = {
+    data: Organization[];
+    meta: PaginationMeta;
+};
+
+type OrganizationByUserResult = {
+    organization: Organization;
+};
+type UpdateOrganizationUserInput = {
+    roleId?: string;
+    avatarReadyPlayerMeImg?: string;
+};
+
+type OrganizationInvite = {
+    id: string;
+    orgId: string;
+    email: string;
+    roleId: string;
+    inviteLinkId: string;
+    avatarReadyPlayerMeImg: string | null;
+    actionAt: string | null;
+    status: InviteStatus;
+    type: InviteType;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type CreateOrganizationInviteInput = {
+    orgId: string;
+    email: string;
+    roleId: string;
+};
+
+type Project = {
+    id: string;
+    orgId: string;
+    name: string;
+    description: string | null;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type CreateProjectInput = {
+    orgId: string;
+    name: string;
+    description?: string | null;
+};
+type UpdateProjectInput = {
+    name?: string;
+    description?: string | null;
+    isActive?: boolean;
+};
+type ProjectListResult = {
+    data: Project[];
+    meta: PaginationMeta;
+};
+
+type UnrealProject = {
+    unrealProjectId: string;
+    unrealProjectVersionId: string;
+};
+type Space = {
+    id: string;
+    orgId: string;
+    projectId: string;
+    name: string;
+    description: string | null;
+    unrealProject: UnrealProject | Record<string, unknown>;
+    currentParticipantSum: number;
+    spaceTemplateId: string;
+    thumb: string | null;
+    spaceItemSum: number;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+    spaceSetting?: SpaceSetting | null;
+};
+type SpaceSetting = {
+    id: string;
+    spaceId: string;
+    isPublic: boolean;
+    afkTimer: number;
+    maxSessionLength: number;
+    allowAnonymousUsers: boolean;
+    allowEmbed: boolean;
+    allowConfigurationToolbarForAllUsers: boolean;
+    disableChat: boolean;
+    disableComms: boolean;
+    enableSharding: boolean;
+    isLiveStreamActive: boolean;
+    showHelpMenu: boolean;
+    showLoadingBackground: boolean;
+    showLoadingBackgroundBlur: boolean;
+    showOdysseyEditorMenu: boolean;
+    showSpaceInformation: boolean;
+    notViewerBuddle: boolean;
+    maximumResolution?: unknown;
+    odysseyMobileControls: OdysseyMobileControls;
+    avatarType: AvatarType;
+    avatarControlSystem: AvatarControlSystem;
+    createdAt: string;
+    updatedAt: string;
+    space?: Space;
+};
+type SpaceUser = {
+    id: string;
+    spaceId: string;
+    email: string;
+    roleId: string;
+    isPending: boolean;
+    avatarUrl: string | null;
+    createdAt: string;
+    updatedAt: string;
+    space?: Space;
+};
+type SpaceInvite = {
+    id: string;
+    spaceId: string;
+    email: string;
+    roleId: string;
+    inviteLinkId: string;
+    avatarReadyPlayerMeImg: string | null;
+    actionAt: string | null;
+    status: InviteStatus;
+    type: InviteType;
+    createdAt: string;
+    updatedAt: string;
+    space?: Space;
+};
+type CreateSpaceInput = {
+    orgId: string;
+    name: string;
+    spaceTemplateId: string;
+    unrealProject: UnrealProject;
+};
+type UpdateSpaceInput = {
+    name?: string;
+    description?: string | null;
+    thumb?: string | null;
+};
+type UpdateSpaceSettingInput = {
+    isPublic?: boolean;
+    afkTimer?: number;
+    maxSessionLength?: number;
+    allowAnonymousUsers?: boolean;
+    allowEmbed?: boolean;
+    allowConfigurationToolbarForAllUsers?: boolean;
+    disableChat?: boolean;
+    disableComms?: boolean;
+    enableSharding?: boolean;
+    isLiveStreamActive?: boolean;
+    showHelpMenu?: boolean;
+    showLoadingBackground?: boolean;
+    showLoadingBackgroundBlur?: boolean;
+    showOdysseyEditorMenu?: boolean;
+    showSpaceInformation?: boolean;
+    notViewerBuddle?: boolean;
+    maximumResolution?: unknown;
+    odysseyMobileControls?: OdysseyMobileControls;
+    avatarType?: AvatarType;
+    avatarControlSystem?: AvatarControlSystem;
+};
+type UpdateSpaceUserInput = {
+    roleId?: string;
+    avatarUrl?: string;
+};
+type CreateSpaceInviteInput = {
+    spaceId: string;
+    email: string;
+    roleId: string;
+};
+
+/**
+ * Health module — server and Redis health checks.
+ */
+
+interface HealthHandle {
+    getHealth(): Promise<HealthResponse>;
+    getRedisHealth(): Promise<RedisHealthResponse>;
+    testRedis(): Promise<void>;
+}
+
+/**
+ * Organization invites module — operations for managing organization invitations.
+ */
+
+interface OrganizationInvitesHandle {
+    create(data: CreateOrganizationInviteInput): Promise<OrganizationInvite>;
+    accept(inviteId: string): Promise<OrganizationInvite>;
+    reject(inviteId: string): Promise<OrganizationInvite>;
+    getPendingUsers(orgId: string): Promise<OrganizationInvite[]>;
+    getPendingUserByInviteId(inviteId: string): Promise<OrganizationInvite | null>;
+}
+
+/**
+ * Organization module — CRUD operations for organizations and organization users.
+ */
+
+interface OrganizationHandle {
+    create(data: CreateOrganizationInput): Promise<Organization>;
+    getAll(query?: PaginationQuery): Promise<OrganizationListResult>;
+    getById(id: string): Promise<Organization>;
+    getByUser(): Promise<OrganizationByUserResult[]>;
+    getUsers(orgId: string): Promise<OrganizationUser[]>;
+    update(id: string, data: UpdateOrganizationInput): Promise<Organization>;
+    updateUser(userId: string, data: UpdateOrganizationUserInput): Promise<OrganizationUser>;
+    delete(id: string): Promise<Organization>;
+    deleteUser(userId: string): Promise<OrganizationUser>;
+}
+
+/**
+ * Projects module — CRUD operations for projects.
+ */
+
+interface ProjectsHandle {
+    create(data: CreateProjectInput): Promise<Project>;
+    getByOrg(orgId: string, query?: PaginationQuery): Promise<ProjectListResult>;
+    getById(projectId: string): Promise<Project>;
+    update(projectId: string, data: UpdateProjectInput): Promise<Project>;
+    delete(projectId: string): Promise<Project>;
+}
+
+/**
+ * Space invites module — operations for managing space invitations.
+ */
+
+interface SpaceInvitesHandle {
+    create(data: CreateSpaceInviteInput): Promise<SpaceInvite>;
+    accept(inviteId: string): Promise<SpaceInvite>;
+    reject(inviteId: string): Promise<SpaceInvite>;
+    getPendingUsers(spaceId: string): Promise<SpaceInvite[]>;
+    getPendingUserByInviteId(inviteId: string): Promise<SpaceInvite | null>;
+}
+
+/**
+ * Spaces module — CRUD operations for spaces, settings, and space users.
+ */
+
+interface SpacesHandle {
+    create(data: CreateSpaceInput): Promise<Space>;
+    getByOrg(orgId: string): Promise<Space[]>;
+    getByProject(projectId: string): Promise<Space[]>;
+    getUsers(spaceId: string): Promise<SpaceUser[]>;
+    update(spaceId: string, data: UpdateSpaceInput): Promise<Space>;
+    updateSetting(spaceId: string, data: UpdateSpaceSettingInput): Promise<SpaceSetting>;
+    updateUser(userId: string, data: UpdateSpaceUserInput): Promise<SpaceUser>;
+    delete(spaceId: string): Promise<Space>;
+    deleteUser(userId: string): Promise<SpaceUser>;
+}
+
+/**
+ * SDK Error factories.
+ */
+interface OdysseyError extends Error {
+    readonly code: string;
+}
+/** Type guard — works for all Odyssey error factories */
+declare function isOdysseyError(err: unknown): err is OdysseyError;
+
+interface OrganizationSDKHandle {
+    health: HealthHandle;
+    organization: OrganizationHandle;
+    organizationInvites: OrganizationInvitesHandle;
+    projects: ProjectsHandle;
+    spaces: SpacesHandle;
+    spaceInvites: SpaceInvitesHandle;
+}
+declare function createOrganizationSDK(config: OrganizationSDKConfig): OrganizationSDKHandle;
+declare const OrganizationSDK: {
+    readonly create: (config: OrganizationSDKConfig) => OrganizationSDKHandle;
+};
+
+export { type AvatarControlSystem, type AvatarType, type CreateOrganizationInput, type CreateOrganizationInviteInput, type CreateProjectInput, type CreateSpaceInput, type CreateSpaceInviteInput, type HealthResponse, type InviteStatus, type InviteType, type OdysseyError, type OdysseyMobileControls, type Organization, type OrganizationByUserResult, type OrganizationConfiguration, type OrganizationInvite, type OrganizationListResult, type OrganizationSDKConfig, type OrganizationSDKHandle, type OrganizationUser, type PaginationMeta, type PaginationQuery, type Project, type ProjectListResult, type RedisHealthResponse, type Space, type SpaceInvite, type SpaceSetting, type SpaceUser, type UpdateOrganizationInput, type UpdateOrganizationUserInput, type UpdateProjectInput, type UpdateSpaceInput, type UpdateSpaceSettingInput, type UpdateSpaceUserInput, createOrganizationSDK, OrganizationSDK as default, isOdysseyError };

package/dist/index.d.ts

@@ -0,0 +1,341 @@
+/**
+ * Shared primitive types and SDK config used across all modules.
+ */
+type OrganizationSDKConfig = {
+    apiKey: string;
+    timeout?: number;
+};
+type PaginationQuery = {
+    page?: number;
+    limit?: number;
+};
+type PaginationMeta = {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+};
+type InviteStatus = "PENDING" | "ACCEPTED" | "REJECTED" | "EXPIRES";
+type InviteType = "EMAIL" | "LINK";
+type OdysseyMobileControls = "ON" | "OFF" | "JOYSTICK_ONLY";
+type AvatarType = "STANDARD" | "AEC";
+type AvatarControlSystem = "EVENT_MODE" | "GAME_MODE" | "FLIGHT_MODE";
+type HealthResponse = {
+    status: string;
+    timestamp: string;
+};
+type RedisHealthResponse = {
+    status: string;
+    latencyMs?: number;
+};
+
+type Organization = {
+    id: string;
+    name: string;
+    domain: string;
+    logoSmallUrl: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type OrganizationUser = {
+    id: string;
+    orgId: string;
+    email: string;
+    roleId: string;
+    avatarReadyPlayerMeImg: string | null;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type OrganizationConfiguration = {
+    id: string;
+    orgId: string;
+    unrealImageId: string;
+    unrealImageRepo: string;
+    workloadClusterProvider: string;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type CreateOrganizationInput = {
+    name: string;
+};
+type UpdateOrganizationInput = {
+    name?: string | null;
+    domain?: string | null;
+    logoSmallUrl?: string | null;
+};
+type OrganizationListResult = {
+    data: Organization[];
+    meta: PaginationMeta;
+};
+
+type OrganizationByUserResult = {
+    organization: Organization;
+};
+type UpdateOrganizationUserInput = {
+    roleId?: string;
+    avatarReadyPlayerMeImg?: string;
+};
+
+type OrganizationInvite = {
+    id: string;
+    orgId: string;
+    email: string;
+    roleId: string;
+    inviteLinkId: string;
+    avatarReadyPlayerMeImg: string | null;
+    actionAt: string | null;
+    status: InviteStatus;
+    type: InviteType;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type CreateOrganizationInviteInput = {
+    orgId: string;
+    email: string;
+    roleId: string;
+};
+
+type Project = {
+    id: string;
+    orgId: string;
+    name: string;
+    description: string | null;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+};
+type CreateProjectInput = {
+    orgId: string;
+    name: string;
+    description?: string | null;
+};
+type UpdateProjectInput = {
+    name?: string;
+    description?: string | null;
+    isActive?: boolean;
+};
+type ProjectListResult = {
+    data: Project[];
+    meta: PaginationMeta;
+};
+
+type UnrealProject = {
+    unrealProjectId: string;
+    unrealProjectVersionId: string;
+};
+type Space = {
+    id: string;
+    orgId: string;
+    projectId: string;
+    name: string;
+    description: string | null;
+    unrealProject: UnrealProject | Record<string, unknown>;
+    currentParticipantSum: number;
+    spaceTemplateId: string;
+    thumb: string | null;
+    spaceItemSum: number;
+    createdAt: string;
+    updatedAt: string;
+    organization?: Organization;
+    spaceSetting?: SpaceSetting | null;
+};
+type SpaceSetting = {
+    id: string;
+    spaceId: string;
+    isPublic: boolean;
+    afkTimer: number;
+    maxSessionLength: number;
+    allowAnonymousUsers: boolean;
+    allowEmbed: boolean;
+    allowConfigurationToolbarForAllUsers: boolean;
+    disableChat: boolean;
+    disableComms: boolean;
+    enableSharding: boolean;
+    isLiveStreamActive: boolean;
+    showHelpMenu: boolean;
+    showLoadingBackground: boolean;
+    showLoadingBackgroundBlur: boolean;
+    showOdysseyEditorMenu: boolean;
+    showSpaceInformation: boolean;
+    notViewerBuddle: boolean;
+    maximumResolution?: unknown;
+    odysseyMobileControls: OdysseyMobileControls;
+    avatarType: AvatarType;
+    avatarControlSystem: AvatarControlSystem;
+    createdAt: string;
+    updatedAt: string;
+    space?: Space;
+};
+type SpaceUser = {
+    id: string;
+    spaceId: string;
+    email: string;
+    roleId: string;
+    isPending: boolean;
+    avatarUrl: string | null;
+    createdAt: string;
+    updatedAt: string;
+    space?: Space;
+};
+type SpaceInvite = {
+    id: string;
+    spaceId: string;
+    email: string;
+    roleId: string;
+    inviteLinkId: string;
+    avatarReadyPlayerMeImg: string | null;
+    actionAt: string | null;
+    status: InviteStatus;
+    type: InviteType;
+    createdAt: string;
+    updatedAt: string;
+    space?: Space;
+};
+type CreateSpaceInput = {
+    orgId: string;
+    name: string;
+    spaceTemplateId: string;
+    unrealProject: UnrealProject;
+};
+type UpdateSpaceInput = {
+    name?: string;
+    description?: string | null;
+    thumb?: string | null;
+};
+type UpdateSpaceSettingInput = {
+    isPublic?: boolean;
+    afkTimer?: number;
+    maxSessionLength?: number;
+    allowAnonymousUsers?: boolean;
+    allowEmbed?: boolean;
+    allowConfigurationToolbarForAllUsers?: boolean;
+    disableChat?: boolean;
+    disableComms?: boolean;
+    enableSharding?: boolean;
+    isLiveStreamActive?: boolean;
+    showHelpMenu?: boolean;
+    showLoadingBackground?: boolean;
+    showLoadingBackgroundBlur?: boolean;
+    showOdysseyEditorMenu?: boolean;
+    showSpaceInformation?: boolean;
+    notViewerBuddle?: boolean;
+    maximumResolution?: unknown;
+    odysseyMobileControls?: OdysseyMobileControls;
+    avatarType?: AvatarType;
+    avatarControlSystem?: AvatarControlSystem;
+};
+type UpdateSpaceUserInput = {
+    roleId?: string;
+    avatarUrl?: string;
+};
+type CreateSpaceInviteInput = {
+    spaceId: string;
+    email: string;
+    roleId: string;
+};
+
+/**
+ * Health module — server and Redis health checks.
+ */
+
+interface HealthHandle {
+    getHealth(): Promise<HealthResponse>;
+    getRedisHealth(): Promise<RedisHealthResponse>;
+    testRedis(): Promise<void>;
+}
+
+/**
+ * Organization invites module — operations for managing organization invitations.
+ */
+
+interface OrganizationInvitesHandle {
+    create(data: CreateOrganizationInviteInput): Promise<OrganizationInvite>;
+    accept(inviteId: string): Promise<OrganizationInvite>;
+    reject(inviteId: string): Promise<OrganizationInvite>;
+    getPendingUsers(orgId: string): Promise<OrganizationInvite[]>;
+    getPendingUserByInviteId(inviteId: string): Promise<OrganizationInvite | null>;
+}
+
+/**
+ * Organization module — CRUD operations for organizations and organization users.
+ */
+
+interface OrganizationHandle {
+    create(data: CreateOrganizationInput): Promise<Organization>;
+    getAll(query?: PaginationQuery): Promise<OrganizationListResult>;
+    getById(id: string): Promise<Organization>;
+    getByUser(): Promise<OrganizationByUserResult[]>;
+    getUsers(orgId: string): Promise<OrganizationUser[]>;
+    update(id: string, data: UpdateOrganizationInput): Promise<Organization>;
+    updateUser(userId: string, data: UpdateOrganizationUserInput): Promise<OrganizationUser>;
+    delete(id: string): Promise<Organization>;
+    deleteUser(userId: string): Promise<OrganizationUser>;
+}
+
+/**
+ * Projects module — CRUD operations for projects.
+ */
+
+interface ProjectsHandle {
+    create(data: CreateProjectInput): Promise<Project>;
+    getByOrg(orgId: string, query?: PaginationQuery): Promise<ProjectListResult>;
+    getById(projectId: string): Promise<Project>;
+    update(projectId: string, data: UpdateProjectInput): Promise<Project>;
+    delete(projectId: string): Promise<Project>;
+}
+
+/**
+ * Space invites module — operations for managing space invitations.
+ */
+
+interface SpaceInvitesHandle {
+    create(data: CreateSpaceInviteInput): Promise<SpaceInvite>;
+    accept(inviteId: string): Promise<SpaceInvite>;
+    reject(inviteId: string): Promise<SpaceInvite>;
+    getPendingUsers(spaceId: string): Promise<SpaceInvite[]>;
+    getPendingUserByInviteId(inviteId: string): Promise<SpaceInvite | null>;
+}
+
+/**
+ * Spaces module — CRUD operations for spaces, settings, and space users.
+ */
+
+interface SpacesHandle {
+    create(data: CreateSpaceInput): Promise<Space>;
+    getByOrg(orgId: string): Promise<Space[]>;
+    getByProject(projectId: string): Promise<Space[]>;
+    getUsers(spaceId: string): Promise<SpaceUser[]>;
+    update(spaceId: string, data: UpdateSpaceInput): Promise<Space>;
+    updateSetting(spaceId: string, data: UpdateSpaceSettingInput): Promise<SpaceSetting>;
+    updateUser(userId: string, data: UpdateSpaceUserInput): Promise<SpaceUser>;
+    delete(spaceId: string): Promise<Space>;
+    deleteUser(userId: string): Promise<SpaceUser>;
+}
+
+/**
+ * SDK Error factories.
+ */
+interface OdysseyError extends Error {
+    readonly code: string;
+}
+/** Type guard — works for all Odyssey error factories */
+declare function isOdysseyError(err: unknown): err is OdysseyError;
+
+interface OrganizationSDKHandle {
+    health: HealthHandle;
+    organization: OrganizationHandle;
+    organizationInvites: OrganizationInvitesHandle;
+    projects: ProjectsHandle;
+    spaces: SpacesHandle;
+    spaceInvites: SpaceInvitesHandle;
+}
+declare function createOrganizationSDK(config: OrganizationSDKConfig): OrganizationSDKHandle;
+declare const OrganizationSDK: {
+    readonly create: (config: OrganizationSDKConfig) => OrganizationSDKHandle;
+};
+
+export { type AvatarControlSystem, type AvatarType, type CreateOrganizationInput, type CreateOrganizationInviteInput, type CreateProjectInput, type CreateSpaceInput, type CreateSpaceInviteInput, type HealthResponse, type InviteStatus, type InviteType, type OdysseyError, type OdysseyMobileControls, type Organization, type OrganizationByUserResult, type OrganizationConfiguration, type OrganizationInvite, type OrganizationListResult, type OrganizationSDKConfig, type OrganizationSDKHandle, type OrganizationUser, type PaginationMeta, type PaginationQuery, type Project, type ProjectListResult, type RedisHealthResponse, type Space, type SpaceInvite, type SpaceSetting, type SpaceUser, type UpdateOrganizationInput, type UpdateOrganizationUserInput, type UpdateProjectInput, type UpdateSpaceInput, type UpdateSpaceSettingInput, type UpdateSpaceUserInput, createOrganizationSDK, OrganizationSDK as default, isOdysseyError };