epicenter-libs 3.11.0

package/src/adapters/presence.ts

@@ -0,0 +1,63 @@
+import type { RoutingOptions } from '../utils/router';
+import type { User } from './user';
+
+import Router from '../utils/router';
+import cometdAdapter from './cometd';
+
+
+interface Presence {
+    lastUpdated: number,
+    ttlSeconds: number,
+    groupRole: 'FACILITATOR' | 'REVIEWER' | 'LEADER' | 'PARTICIPANT',
+    user: User,
+}
+
+
+/**
+ * Makes a connection request to the cometd server; effectively marking the user as online. This isn't required to be called in order to be considered online. Subscribe to a CometD channel will do the same as well. This is just a convenience method for when you don't need to utilize the channels expect specifically for presence.
+ * Using [logout](#authAdapter-logout) will automatically disconnect for you.
+ * @example
+ * epicenter.presenceAdapter.connect()
+ * @returns promise indicating whether or not the connection was successful
+ */
+export async function connect(): Promise<void> {
+    await cometdAdapter.handshake();
+    return;
+}
+
+
+/**
+ * Retrieves the presence information for a particular group
+ * @example
+ * epicenter.presenceAdapter.forGroup('0000017dd3bf540e5ada5b1e058f08f20461');
+ * @param groupKey      Key associated with group
+ * @param [optionals]   Optional arguments; pass network call options overrides here.
+ * @returns promise that resolves to a list of users online
+ */
+export async function forGroup(
+    groupKey: string,
+    optionals: RoutingOptions = {}
+): Promise<Presence[]> {
+    return await new Router()
+        .get(`/presence/group/${groupKey}`, optionals)
+        .then(({ body }) => body);
+}
+
+
+/**
+ * Retrieves the presence information for a particular world
+ * @example
+ * epicenter.presenceAdapter.forWorld('0000017a445032dc38cb2cecd5fc13708314')
+ * @param worldKey      Key associated with world
+ * @param [optionals]   Optional arguments; pass network call options overrides here.
+ * @returns promise that resolves to a list of users online
+ */
+export async function forWorld(
+    worldKey: string,
+    optionals: RoutingOptions = {},
+): Promise<Presence[]> {
+    return await new Router()
+        .get(`/presence/world/${worldKey}`, optionals)
+        .then(({ body }) => body);
+}
+

package/src/adapters/project.ts

@@ -0,0 +1,123 @@
+import type { RoutingOptions } from '../utils/router';
+import { ROLE, Router } from '../utils';
+
+enum ACCESS_TYPE {
+    PUBLIC = 'PUBLIC',
+    PRIVATE = 'PRIVATE',
+    AUTHENTICATED = 'AUTHENTICATED',
+}
+
+enum WORKER_PARTITION {
+    NONE = 'NONE',
+    ALL = 'ALL',
+    FREE = 'FREE',
+    LICENSED = 'LICENSED',
+    ACCOUNT = 'ACCOUNT',
+}
+
+enum PHYLOGENY {
+    ORIGINAL = 'ORIGINAL',
+    HISTORICAL = 'HISTORICAL',
+    REFERENTIAL = 'REFERENTIAL',
+    ORDERED = 'ORDERED',
+    EVENTUAL = 'EVENTUAL',
+}
+
+enum FILE_TYPE {
+    INSENSITIVE = 'INSENSITIVE',
+    SENSITIVE = 'SENSITIVE',
+}
+
+interface Member {
+    role: ROLE.AUTHOR,
+    adminKey: string,
+    objectType: 'project',
+}
+
+interface Deployment {
+    defaultGroupName: string,
+    autoCreatePlayer: boolean,
+    loginFile: string,
+    welcomeFile: string,
+    groupFile: string,
+}
+
+interface TeamProject {
+    concurrentRunLimit: number,
+    modelFile: string,
+    available: boolean,
+    allowWorldSelfAssign: boolean,
+    legacySettings: {
+        blockDirectApiCalls: boolean,
+        channelAuthorizationRequired: boolean,
+        filePermissionsActive: boolean,
+        showEmail: boolean,
+        transmogrifierActive: boolean,
+        dataApiAllowAnonymousAccess: boolean,
+        channelVersion: number,
+        authorizationMode: 'LEGACY' | 'USER',
+        dataApiEnforceScope: boolean,
+    },
+    objectType: 'team',
+    accessType: keyof typeof ACCESS_TYPE,
+    sessionTimeoutSeconds: number,
+    projectKey: string,
+    members: Member[],
+    channelEnabled: boolean,
+    workerPartition: keyof typeof WORKER_PARTITION,
+    name: string,
+    phylogeny: keyof typeof PHYLOGENY,
+    multiPlayerEnabled: boolean,
+    shortName: string,
+    approximateRunCount: number,
+    pricing: {
+        amount: number,
+    },
+    dataRetentionDays: number,
+    fileType: keyof typeof FILE_TYPE,
+    dimensions: 'UNIVERSE' | 'MULTIVERSE',
+    deployment: Deployment,
+}
+
+interface PersonalProject {
+    concurrentRunLimit: number,
+    available: boolean,
+    objectType: 'personal',
+    accessType: keyof typeof ACCESS_TYPE,
+    sessionTimeoutSeconds: number,
+    projectKey: string,
+    workerPartition: keyof typeof WORKER_PARTITION,
+    name: string,
+    phylogeny: keyof typeof PHYLOGENY,
+    shortName: string,
+    approximateRunCount: number,
+    fileType: keyof typeof FILE_TYPE,
+    deployment: Deployment,
+}
+
+type Project =
+    | TeamProject
+    | PersonalProject;
+
+/**
+ * Checks to see if the project currently has the push channels enabled
+ * @example
+ * epicenter.projectAdapter.channelsEnabled();
+ * @param [optionals]   Optional arguments; pass network call options overrides here.
+ * @returns promise resolving true/false whether or not the project supports the use of push channels
+ */
+export async function channelsEnabled(
+    optionals: RoutingOptions = {}
+): Promise<boolean> {
+    return await new Router()
+        .get('/project/channel/isEnabled', optionals)
+        .then(({ body }) => body);
+}
+
+export async function get(
+    optionals: RoutingOptions = {}
+): Promise<Project> {
+    return await new Router()
+        .get('/project', optionals)
+        .then(({ body }) => body);
+}

package/src/adapters/recaptcha.ts

@@ -0,0 +1,11 @@
+import {Router} from 'utils/index';
+
+export async function google(humanKey: string) {
+    return await new Router()
+        .withAccountShortName('epicenter')
+        .withProjectShortName('manager')
+        .post('/recaptcha/google', {
+            body: {humanKey: humanKey},
+        })
+        .then(({body}) => body);
+}