@taskeren/bungie-api-ts 5.10.0

package/build.sh

@@ -0,0 +1,30 @@
+#!/bin/sh -ex
+
+rm -rf ./build
+cp package.json generator
+
+# Prepare the generated source directory
+rm -rf ./generated-src
+mkdir -p generated-src
+cp generator/http.ts generated-src
+
+# Compile and run the generator
+pnpm tsc -p tsconfig.json
+node ./build/generate.js
+
+# Build the package from the generated sources
+rm -rf ./lib
+mkdir -p lib
+rsync -a --include '*/' --include '*.d.ts' --exclude '*' generated-src/ lib/
+cp ./generated-src/package.json.notyet ./lib/package.json
+
+babel generated-src --out-dir lib --extensions ".ts"
+
+pnpm tsc -p tsconfig-package.json
+
+pnpm prettier --write lib/**/*
+
+# Copy files into lib - we'll publish lib as the package instead of the whole repo, so paths are nicer.
+cp README.md lib/
+cp bungie-api-LICENSE lib/
+rm generator/package.json

package/bungie-api-LICENSE

@@ -0,0 +1,29 @@
+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/generated-src/app/api.ts

@@ -0,0 +1,50 @@
+/**
+ * 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, get, post } from '../http.js';
+
+import {
+  ApiUsage,
+  Application
+} from './interfaces.js';
+import {
+  ServerResponse
+} from '../common.js';
+
+const API_BASE = "https://www.bungie.net/Platform/App/";
+
+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 function getApplicationApiUsage(http: HttpClient, params: GetApplicationApiUsageParams): Promise<ServerResponse<ApiUsage>> {
+  const strParams: Record<string, string> = {};
+  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);
+}
+
+/** Get list of applications created by Bungie. */
+export function getBungieApplications(http: HttpClient): Promise<ServerResponse<Application[]>> {
+  return get(http, `${API_BASE}FirstParty/`);
+}

package/generated-src/app/index.ts

@@ -0,0 +1,17 @@
+/**
+ * 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/generated-src/app/interfaces.ts

@@ -0,0 +1,119 @@
+/**
+ * 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 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 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 const enum DeveloperRole {
+  None = 0,
+  Owner = 1,
+  TeamMember = 2
+}