@taskeren/bungie-api-ts 5.10.0

package/generator/http.ts

@@ -0,0 +1,52 @@
+export type HttpQueryParams = Record<string, string>;
+
+export interface HttpClientConfig {
+  method: 'GET' | 'POST';
+  url: string;
+  /** Query string params */
+  params?: HttpQueryParams;
+  /** Request body */
+  body?: any;
+}
+
+/**
+ * A generic, minimal type for providing an HTTP client function.
+ * This gets the necessary config provided as an argument, and then
+ * should produce a promise for the parsed JSON as a result. The API
+ * helper functions will use this to return the right type.
+ */
+export type HttpClient = <Return>(config: HttpClientConfig) => Promise<Return>;
+
+export function get<Return>(
+  http: HttpClient,
+  url: string,
+  params?: HttpQueryParams
+): Promise<Return> {
+  return http(
+    params
+      ? {
+          method: 'GET',
+          url,
+          params,
+        }
+      : {
+          method: 'GET',
+          url,
+        }
+  );
+}
+
+export function post<Return>(http: HttpClient, url: string, body?: any): Promise<Return> {
+  return http(
+    body
+      ? {
+          method: 'POST',
+          url,
+          body,
+        }
+      : {
+          method: 'POST',
+          url,
+        }
+  );
+}

package/generator/missing-props.ts

@@ -0,0 +1,11 @@
+import { SchemaObject } from 'openapi3-ts';
+
+export const missingPropsByInterfaceName: {
+  [propertyName: string]: SchemaObject;
+} = {
+  DestinyArtifactTierItem: {
+    isVisible: {
+      type: 'boolean',
+    },
+  },
+};

package/generator/type-index.ts

@@ -0,0 +1,184 @@
+import _ from 'lodash';
+import {
+  OpenAPIObject,
+  PathItemObject,
+  ParameterObject,
+  SchemaObject,
+  ReferenceObject,
+} from 'openapi3-ts';
+import {
+  getRef,
+  lastPart,
+  getReferencedTypes,
+  DefInfo,
+  interfaceName,
+  isRequestBodyObject,
+} from './util.js';
+
+export function computeTypeMaps(
+  pathPairsByTag: { [tag: string]: [string, PathItemObject][] },
+  doc: OpenAPIObject
+) {
+  const allDefsEverywhere = new Set<string>();
+  const defsByTag: { [tag: string]: Set<string> } = {};
+  _.each(pathPairsByTag, (paths, tag) => {
+    const defs = findReachableComponents(paths, doc);
+    addAll(allDefsEverywhere, defs);
+    defsByTag[tag] = defs;
+  });
+
+  // Add manifest tables that aren't referenced by any API endpoint.
+  for (const [defName, def] of Object.entries(doc.components!.schemas!)) {
+    const typePath = `#/components/schemas/${defName}`;
+    if (
+      !allDefsEverywhere.has(typePath) &&
+      'type' in def &&
+      def.type === 'object' &&
+      def['x-mobile-manifest-name']
+    ) {
+      console.log(`Found unreferenced manifest table ${typePath}`);
+      allDefsEverywhere.add(typePath);
+      addReachableComponentsFromComponent(allDefsEverywhere, typePath, doc);
+    }
+  }
+
+  const allTags = Object.keys(pathPairsByTag);
+
+  const componentsByFile: { [filename: string]: DefInfo[] } = {};
+  const componentByDef: { [def: string]: DefInfo } = {};
+  for (const def of allDefsEverywhere) {
+    const tags: string[] = [];
+    _.each(defsByTag, (defs: Set<string>, tag) => {
+      if (defs.has(def)) {
+        tags.push(tag);
+      }
+    });
+    const info: DefInfo = {
+      def,
+      tags,
+      filename: chooseFile(def, tags, allTags),
+      interfaceName: interfaceName(def, doc),
+    };
+
+    componentsByFile[info.filename] = componentsByFile[info.filename] || [];
+    componentsByFile[info.filename].push(info);
+    componentByDef[info.def] = info;
+  }
+
+  return { componentsByFile, componentByDef };
+}
+
+// TODO: put enums in a separate file???
+// TODO: put things ending in Request in a separate file?
+// TODO: put manifest stuff in a separate file?
+function chooseFile(def: string, tags: string[], allTags: string[]) {
+  const schemaName: string = _.last(def.split('/'))!;
+  const matchingTag = allTags.find((tag) => schemaName.startsWith(tag + '.'));
+
+  const filename = '/interfaces.ts';
+  if (matchingTag) {
+    return matchingTag.toLowerCase() + filename;
+  } else if (schemaName.startsWith('GroupsV2.')) {
+    return 'groupv2' + filename;
+  } else if (schemaName.startsWith('Destiny.')) {
+    return 'destiny2' + filename;
+  } else {
+    if (tags.length === 1) {
+      return tags[0].toLowerCase() + filename;
+    } else if (!tags.includes('Destiny2')) {
+      return 'platform.ts';
+    } else {
+      return 'common.ts';
+    }
+  }
+}
+
+function findReachableComponents(paths: [string, PathItemObject][], doc: OpenAPIObject) {
+  const pathDefinitions = paths.reduce(
+    (memo: Set<string>, [_, pathDef]) => addAll(memo, findReachableComponentsFromPath(pathDef)),
+    new Set<string>()
+  );
+
+  const allDefinitions = new Set(pathDefinitions);
+  pathDefinitions.forEach((definition) =>
+    addReachableComponentsFromComponent(allDefinitions, definition, doc)
+  );
+  return allDefinitions;
+}
+
+function addAll<T>(first: Set<T>, second: Set<T>): Set<T> {
+  for (const value of second) {
+    first.add(value);
+  }
+  return first;
+}
+
+function findReachableComponentsFromPath(pathDef: PathItemObject): Set<string> {
+  const methodDef = pathDef.get || pathDef.post!;
+  const params = (methodDef.parameters || []) as ParameterObject[];
+  const paramTypes = new Set(
+    params.map((param) => getReferencedTypes(param.schema!)).filter((p) => p)
+  ) as Set<string>;
+
+  const requestBody = methodDef.requestBody;
+  if (requestBody && isRequestBodyObject(requestBody)) {
+    const schema = requestBody.content['application/json'].schema!;
+    const paramType = getReferencedTypes(schema);
+    if (paramType) {
+      paramTypes.add(paramType);
+    }
+  }
+
+  const returnType = getReferencedTypes(methodDef.responses['200']);
+  if (returnType) {
+    paramTypes.add(returnType);
+  }
+
+  return paramTypes;
+}
+
+function addReachableComponentsFromComponent(
+  allDefinitions: Set<string>,
+  definition: string,
+  doc: OpenAPIObject
+) {
+  const component = getRef(doc, definition);
+  if (!component) {
+    return;
+  }
+
+  if (component && component.type === 'array') {
+    addDefinitions(allDefinitions, component.items!, doc);
+  } else if (component.type === 'object') {
+    if (component.properties) {
+      Object.values(component.properties).forEach((schema: SchemaObject | ReferenceObject) => {
+        addDefinitions(allDefinitions, schema, doc);
+      });
+    }
+    (component.allOf || []).forEach((schema: SchemaObject | ReferenceObject) => {
+      addDefinitions(allDefinitions, schema, doc);
+    });
+    if (component.additionalProperties && typeof component.additionalProperties !== 'boolean') {
+      addDefinitions(allDefinitions, component.additionalProperties, doc);
+    }
+  }
+}
+
+function addDefinitions(allDefinitions: Set<string>, schema: SchemaObject, doc: OpenAPIObject) {
+  const newDefinition = getReferencedTypes(schema);
+  addDefinitionsFromComponent(allDefinitions, newDefinition, doc);
+  if (schema['x-mapped-definition']) {
+    addDefinitionsFromComponent(allDefinitions, schema['x-mapped-definition'].$ref, doc);
+  }
+}
+
+function addDefinitionsFromComponent(
+  allDefinitions: Set<string>,
+  definition: string | undefined,
+  doc: OpenAPIObject
+) {
+  if (definition && !allDefinitions.has(definition)) {
+    allDefinitions.add(definition);
+    addReachableComponentsFromComponent(allDefinitions, definition, doc);
+  }
+}

package/generator/util.ts

@@ -0,0 +1,131 @@
+import { SchemaObject, ReferenceObject, OpenAPIObject, RequestBodyObject } from 'openapi3-ts';
+import _ from 'lodash';
+
+export interface DefInfo {
+  def: string;
+  tags: string[];
+  filename: string;
+  interfaceName: string;
+}
+
+export function resolveSchemaType(
+  schema: SchemaObject | ReferenceObject,
+  doc: OpenAPIObject
+): string {
+  if (isReferenceObject(schema)) {
+    return interfaceName(schema.$ref, doc);
+  } else if (schema['x-enum-reference']) {
+    return interfaceName(schema['x-enum-reference'].$ref, doc);
+  } else {
+    return typeMapping(schema, doc);
+  }
+}
+
+export function typeMapping(schema: SchemaObject, doc: OpenAPIObject): string {
+  switch (schema.type) {
+    case 'string':
+      return schema.format === 'byte' ? 'number' : 'string';
+    case 'integer':
+      // JS can't represent a 64-bit int as a number, so bungie.net returns it as a string in JSON
+      return schema.format === 'int64' ? 'string' : 'number';
+
+    case 'array':
+      return resolveSchemaType(schema.items!, doc) + '[]';
+    case 'object':
+      if (schema.allOf) {
+        return resolveSchemaType(schema.allOf[0], doc);
+      } else if (
+        schema.additionalProperties &&
+        schema['x-dictionary-key'] &&
+        typeof schema.additionalProperties !== 'boolean'
+      ) {
+        const keySchema: SchemaObject | ReferenceObject = schema['x-dictionary-key'];
+        const key = isReferenceObject(keySchema) ? 'number' : resolveSchemaType(keySchema, doc);
+        const val = resolveSchemaType(schema.additionalProperties, doc);
+        const keyExp = key === 'number' || key === 'string' ? `key: ${key}` : `key in ${key}`;
+        return `{ [${keyExp}]: ${val} }`;
+      }
+  }
+
+  return schema.type!;
+}
+
+export function getReferencedTypes(schema: SchemaObject | ReferenceObject): string | undefined {
+  if (isReferenceObject(schema)) {
+    return schema.$ref;
+  } else if (schema['x-enum-reference']) {
+    return schema['x-enum-reference'].$ref;
+  } else if (schema.items) {
+    return getReferencedTypes(schema.items!);
+  } else if (schema.allOf) {
+    return getReferencedTypes(schema.allOf[0]);
+  } else if (schema.additionalProperties && typeof schema.additionalProperties !== 'boolean') {
+    return getReferencedTypes(schema.additionalProperties);
+  }
+}
+
+export function lcFirst(name: string): string {
+  return name[0].toLowerCase() + name.substring(1);
+}
+
+export function lastPart(name: string): string {
+  return _.last(name.split(/[\.\/]/))!;
+}
+
+export function getRef(doc: OpenAPIObject, ref: string): SchemaObject | undefined {
+  const path = ref.replace('#/', '').split('/');
+  let result = doc;
+  let pathSegment = path.shift();
+  while (pathSegment) {
+    result = result[pathSegment];
+    pathSegment = path.shift();
+  }
+  if (!result) {
+    return undefined;
+  }
+  if (result.content) {
+    return result.content['application/json'].schema;
+  } else {
+    return result;
+  }
+}
+
+export function interfaceName(componentPath: string, doc: OpenAPIObject) {
+  const name = lastPart(componentPath);
+  const component = getRef(doc, componentPath);
+  if (!component) {
+    return 'any';
+  }
+
+  const singleResponse = name.match(/SingleComponentResponseOf(.*)/);
+  if (singleResponse) {
+    return `SingleComponentResponse<${singleResponse[1]}>`;
+  }
+
+  const dictionaryResponse = name.match(/DictionaryComponentResponseOfu?int(?:64|32)And(.*)/);
+  if (dictionaryResponse) {
+    return `DictionaryComponentResponse<${dictionaryResponse[1]}>`;
+  }
+
+  if (componentPath.includes('/responses/')) {
+    const property = component.properties!.Response;
+    if (property) {
+      const paramType = resolveSchemaType(property, doc);
+      return `ServerResponse<${paramType}>`;
+    }
+  }
+
+  return name;
+}
+
+export function isRequestBodyObject(
+  requestBody: RequestBodyObject | ReferenceObject
+): requestBody is RequestBodyObject {
+  return (requestBody as RequestBodyObject).content !== undefined;
+}
+
+export function isReferenceObject(
+  schema: SchemaObject | ReferenceObject
+): schema is ReferenceObject {
+  return (schema as ReferenceObject).$ref !== undefined;
+}

package/lib/README.md

@@ -0,0 +1,97 @@
+# Bungie API TypeScript support
+
+This project implements TypeScript definitions and API helpers for the [Bungie.net API](https://github.com/Bungie-net/api). It's meant for use in [Destiny Item Manager](https://destinyitemmanager.com), but should be general enough to use in any project. The code is completely generated from Bungie's documentation - I considered using something like Swagger Codegen, but instead opted for a custom generator so we could make the result as nice as possible.
+
+# Ports
+
+Feel free to fork this and use it to generate for your favorite language!
+
+- [Dart](https://github.com/marquesinijatinha/bungie-api-dart/)
+
+# Install
+
+```
+pnpm add bungie-api-ts
+```
+
+# Interfaces and Enums
+
+All the interface type definitions and enums are for type info only - everything will compile out. Only the API helpers produce real JavaScript output. You can import types from each service defined on Bungie.net:
+
+```typescript
+import { DestinyInventoryComponent, DestinyInventoryItemDefinition } from 'bungie-api-ts/destiny2';
+```
+
+There are definitions for every type defined in the Bungie.net services. See [their documentation](https://bungie-net.github.io/multi/) for a list - the interface names are the last part of the full name (for example, `Destiny.Definitions.DestinyVendorActionDefinition` becomes `DestinyVendorActionDefinition`). There are a few exceptions, like `SingleComponentResponseOfDestinyInventoryComponent`, which have been mapped into nicer forms like `SingleComponentResponse<DestinyInventoryComponent>`, and the server responses, which are now `ServerResponse<T>` instead of something like `DestinyCharacterResponse`.
+
+# API Helpers
+
+In addition to the types, there are also simple helper functions for each API endpoint. They define the inputs and outputs to that endpoint, and will call a user-provided function with HTTP request info that you can then use to make an HTTP request. This pattern was used so the API helpers could provide full type information. These helpers are not a full API client - they assist in building one. An example:
+
+```typescript
+import { getProfile, HttpClientConfig } from 'bungie-api-ts/destiny2';
+
+async function $http(config: HttpClientConfig) {
+  // fill in the API key, handle OAuth, etc., then make an HTTP request using the config.
+  return fetch(config.url, ...);
+}
+
+const profileInfo: ServerResponse<DestinyProfileResponse> = await getProfile($http, {
+  components: [DestinyComponentType.Profiles, DestinyComponentType.Characters],
+  destinyMembershipId: 12345,
+  membershipType: BungieMembershipType.TigerPsn
+});
+```
+
+# Imports
+
+It is possible to import all services from `bungie-api-ts` directly, but it's better to import the specific service and pick out what you want:
+
+```typescript
+// good
+import { getProfile, HttpClientConfig } from 'bungie-api-ts/destiny2';
+getProfile(...);
+
+// works, but not as good
+import { Destiny2 } from 'bungie-api-ts';
+Destiny2.getProfile(...);
+```
+
+# Manifest Helpers
+
+The `destiny2` import also contains helpers for typing and downloading the Destiny manifest:
+
+```typescript
+import { getDestinyManifestSlice, getDestinyManifest, type HttpClientConfig } from 'bungie-api-ts/destiny2';
+
+async function $http(config: HttpClientConfig) {
+  // fill in the API key, handle OAuth, etc., then make an HTTP request using the config.
+  return fetch(config.url, ...);
+}
+
+const destinyManifest = await getDestinyManifest($http);
+const manifestTables = getDestinyManifestSlice($http, {
+  destinyManifest: destinyManifest.Response,
+  tableNames: ['DestinyInventoryItemDefinition', 'DestinySocketDefinition'],
+  language: 'en',
+});
+
+// manifestTables is an object with properties DestinyInventoryItemDefinition and DestinySocketDefinition
+```
+
+# Build
+
+```
+# setup
+pnpm i && pnpm submodule
+# run
+pnpm start
+```
+
+# Updating API sources
+
+Run the [update API sources](https://github.com/DestinyItemManager/bungie-api-ts/actions/workflows/update.yml) GitHub Action and it should create a new PR for the updated sources.
+
+# Publishing
+
+Update the version in `package.json`, and when the PR merges to `master`, a GitHub workflow will automatically publish to NPM. Don't forget to run `pnpm start` and commit all changed files!

package/lib/app/api.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+import { HttpClient } from '../http.js';
+import { ApiUsage, Application } from './interfaces.js';
+import { ServerResponse } from '../common.js';
+export interface GetApplicationApiUsageParams {
+  /** ID of the application to get usage statistics. */
+  applicationId: number;
+  /** End time for query. Goes to now if not specified. */
+  end?: string;
+  /** Start time for query. Goes to 24 hours ago if not specified. */
+  start?: string;
+}
+/**
+ * Get API usage by application for time frame specified. You can go as far back as
+ * 30 days ago, and can ask for up to a 48 hour window of time in a single request.
+ * You must be authenticated with at least the ReadUserData permission to access
+ * this endpoint.
+ */
+export declare function getApplicationApiUsage(
+  http: HttpClient,
+  params: GetApplicationApiUsageParams
+): Promise<ServerResponse<ApiUsage>>;
+/** Get list of applications created by Bungie. */
+export declare function getBungieApplications(
+  http: HttpClient
+): Promise<ServerResponse<Application[]>>;

package/lib/app/api.js

@@ -0,0 +1,15 @@
+import { get } from '../http.js';
+const API_BASE = 'https://www.bungie.net/Platform/App/';
+export function getApplicationApiUsage(http, params) {
+  const strParams = {};
+  if (params.end !== undefined) {
+    strParams.end = params.end;
+  }
+  if (params.start !== undefined) {
+    strParams.start = params.start;
+  }
+  return get(http, `${API_BASE}ApiUsage/${params.applicationId}/`, strParams);
+}
+export function getBungieApplications(http) {
+  return get(http, `${API_BASE}FirstParty/`);
+}

package/lib/app/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+export * from '../common.js';
+export * from '../platform.js';
+export type { HttpClientConfig, HttpClient } from '../http.js';
+export * from './api.js';
+export * from './interfaces.js';

package/lib/app/index.js

@@ -0,0 +1,5 @@
+export * from '../common.js';
+export * from '../platform.js';
+export * from './api.js';
+export * from './interfaces.js';
+export {};

package/lib/app/interfaces.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+import { UserInfoCard } from '../user/interfaces.js';
+export interface ApiUsage {
+  /** Counts for on API calls made for the time range. */
+  readonly apiCalls: Series[];
+  /**
+   * Instances of blocked requests or requests that crossed the warn threshold during
+   * the time range.
+   */
+  readonly throttledRequests: Series[];
+}
+export interface Series {
+  /** Collection of samples with time and value. */
+  readonly datapoints: Datapoint[];
+  /** Target to which to datapoints apply. */
+  readonly target: string;
+}
+export interface Datapoint {
+  /** Timestamp for the related count. */
+  readonly time: string;
+  /** Count associated with timestamp */
+  readonly count?: number;
+}
+export interface Application {
+  readonly applicationType: OAuthApplicationType;
+  /** Unique ID assigned to the application */
+  readonly applicationId: number;
+  /** Name of the application */
+  readonly name: string;
+  /** URL used to pass the user's authorization code to the application */
+  readonly redirectUrl: string;
+  /** Link to website for the application where a user can learn more about the app. */
+  readonly link: string;
+  /** Permissions the application needs to work */
+  readonly scope: string;
+  /** Value of the Origin header sent in requests generated by this application. */
+  readonly origin: string;
+  /** Current status of the application. */
+  readonly status: ApplicationStatus;
+  /** Date the application was first added to our database. */
+  readonly creationDate: string;
+  /** Date the application status last changed. */
+  readonly statusChanged: string;
+  /** Date the first time the application status entered the 'Public' status. */
+  readonly firstPublished: string;
+  /**
+   * List of team members who manage this application on Bungie.net. Will always
+   * consist of at least the application owner.
+   */
+  readonly team: ApplicationDeveloper[];
+  /** An optional override for the Authorize view name. */
+  readonly overrideAuthorizeViewName: string;
+}
+export declare const enum OAuthApplicationType {
+  None = 0,
+  /**
+   * Indicates the application is server based and can keep its secrets from end
+   * users and other potential snoops.
+   */
+  Confidential = 1,
+  /**
+   * Indicates the application runs in a public place, and it can't be trusted to
+   * keep a secret.
+   */
+  Public = 2,
+}
+export declare const enum ApplicationStatus {
+  /** No value assigned */
+  None = 0,
+  /**
+   * Application exists and works but will not appear in any public catalog. New
+   * applications start in this state, test applications will remain in this state.
+   */
+  Private = 1,
+  /** Active applications that can appear in an catalog. */
+  Public = 2,
+  /**
+   * Application disabled by the owner. All authorizations will be treated as
+   * terminated while in this state. Owner can move back to private or public state.
+   */
+  Disabled = 3,
+  /**
+   * Application has been blocked by Bungie. It cannot be transitioned out of this
+   * state by the owner. Authorizations are terminated when an application is in this
+   * state.
+   */
+  Blocked = 4,
+}
+export interface ApplicationDeveloper {
+  readonly role: DeveloperRole;
+  readonly apiEulaVersion: number;
+  readonly user: UserInfoCard;
+}
+export declare const enum DeveloperRole {
+  None = 0,
+  Owner = 1,
+  TeamMember = 2,
+}

package/lib/app/interfaces.js

@@ -0,0 +1,17 @@
+export var OAuthApplicationType = {
+  None: 0,
+  Confidential: 1,
+  Public: 2,
+};
+export var ApplicationStatus = {
+  None: 0,
+  Private: 1,
+  Public: 2,
+  Disabled: 3,
+  Blocked: 4,
+};
+export var DeveloperRole = {
+  None: 0,
+  Owner: 1,
+  TeamMember: 2,
+};