@taskeren/bungie-api-ts 5.10.0 → 5.10.2

package/generator/http.ts

@@ -1,52 +0,0 @@
-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

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

package/generator/type-index.ts

@@ -1,184 +0,0 @@
-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

@@ -1,131 +0,0 @@
-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

@@ -1,97 +0,0 @@
-# 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/bungie-api-LICENSE

@@ -1,29 +0,0 @@
-Bungie SDK License Agreement (BSD 3-Clause License)
-
-Copyright (c) 2017, Bungie, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/lib/package.json

@@ -1,99 +0,0 @@
-{
-  "name": "bungie-api-ts",
-  "version": "5.10.0",
-  "description": "TypeScript mappings for the Bungie.net API",
-  "type": "module",
-  "sideEffects": false,
-  "scripts": {},
-  "jest": {
-    "preset": "ts-jest/presets/js-with-babel-esm",
-    "testEnvironment": "node",
-    "moduleNameMapper": {
-      "^(\\.{1,2}/.*)\\.js$": "$1"
-    }
-  },
-  "engines": {
-    "node": ">=13.2.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/DestinyItemManager/bungie-api-ts.git"
-  },
-  "author": "Ben Hollis",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/DestinyItemManager/bungie-api-ts/issues"
-  },
-  "keywords": [
-    "Destiny",
-    "Bungie",
-    "Bungie.net",
-    "TypeScript"
-  ],
-  "homepage": "https://github.com/DestinyItemManager/bungie-api-ts",
-  "devDependencies": {},
-  "packageManager": "pnpm@8.15.9+sha512.499434c9d8fdd1a2794ebf4552b3b25c0a633abcee5bb15e7b5de90f32f47b513aca98cd5cfd001c31f0db454bc3804edccd578501e4ca293a6816166bbd9f81",
-  "main": "./index.js",
-  "types": "./index.d.ts",
-  "module": "./index.js",
-  "exports": {
-    ".": {
-      "default": "./index.js",
-      "types": "./index.d.ts"
-    },
-    "./http": {
-      "default": "./http.js",
-      "types": "./http.d.ts"
-    },
-    "./package.json": "./package.json",
-    "./app": {
-      "default": "./app/index.js",
-      "types": "./app/index.d.ts"
-    },
-    "./user": {
-      "default": "./user/index.js",
-      "types": "./user/index.d.ts"
-    },
-    "./content": {
-      "default": "./content/index.js",
-      "types": "./content/index.d.ts"
-    },
-    "./forum": {
-      "default": "./forum/index.js",
-      "types": "./forum/index.d.ts"
-    },
-    "./groupv2": {
-      "default": "./groupv2/index.js",
-      "types": "./groupv2/index.d.ts"
-    },
-    "./tokens": {
-      "default": "./tokens/index.js",
-      "types": "./tokens/index.d.ts"
-    },
-    "./destiny2": {
-      "default": "./destiny2/index.js",
-      "types": "./destiny2/index.d.ts"
-    },
-    "./communitycontent": {
-      "default": "./communitycontent/index.js",
-      "types": "./communitycontent/index.d.ts"
-    },
-    "./trending": {
-      "default": "./trending/index.js",
-      "types": "./trending/index.d.ts"
-    },
-    "./fireteam": {
-      "default": "./fireteam/index.js",
-      "types": "./fireteam/index.d.ts"
-    },
-    "./social": {
-      "default": "./social/index.js",
-      "types": "./social/index.d.ts"
-    },
-    "./core": {
-      "default": "./core/index.js",
-      "types": "./core/index.d.ts"
-    }
-  },
-  "dependencies": {}
-}

package/test-consumer.ts

@@ -1,5 +0,0 @@
-import { getDestinyManifest } from './lib/destiny2/api.js';
-
-const fakeHttp = async (config) => console.log(config.url);
-
-getDestinyManifest(fakeHttp);