deepsight.gg 1.0.79

package/Interfaces.d.ts

@@ -0,0 +1,317 @@
+import type { DestinyDisplayPropertiesDefinition, DestinyItemComponentSetOfint32, DestinyItemQuantity, DestinyVendorCategoryEntryDefinition, DestinyVendorItemDefinition, DestinyVendorLocationDefinition, DictionaryComponentResponse, TierType } from "bungie-api-ts/destiny2";
+import type { ActivityHashes, ActivityModifierHashes, EventCardHashes, InventoryItemHashes, ItemTierTypeHashes, MomentHashes, SeasonHashes, VendorGroupHashes, VendorHashes } from "./Enums";
+
+export declare type ISOString = `${bigint}-${"0" | ""}${bigint}-${"0" | ""}${bigint}T${"0" | ""}${bigint}:${"0" | ""}${bigint}:${"0" | ""}${bigint}Z`;
+
+export declare interface DeepsightManifest {
+	/**
+	 * This number increments whenever any other property changes (excluding Destiny2/Manifest)
+	 */
+	deepsight: number;
+	/**
+	 * A datetime string in the ISO format, yyyy-mm-ddThh:mm:ssZ, representing the last time any property has changed
+	 */
+	updated: ISOString;
+
+	DeepsightDropTableDefinition: number;
+	DeepsightMomentDefinition: number;
+	DeepsightPlugCategorisation: number;
+	DeepsightWallpaperDefinition: number;
+	DeepsightTierTypeDefinition: number;
+	Enums: number;
+	Interfaces: number;
+
+	/**
+	 * The version of the Destiny manifest the current deepsight manifest supports
+	 */
+	"Destiny2/Manifest": string;
+
+	/**
+	 * A datetime string in the ISO format, yyyy-mm-ddThh:mm:ssZ, representing the last daily reset from when this manifest was last updated.  
+	 * 
+	 * **Note that this is only set after 30 minutes, at minimum, sometimes longer.**
+	 */
+	lastDailyReset: ISOString;
+	/**
+	 * A datetime string in the ISO format, yyyy-mm-ddThh:mm:ssZ, representing the last weekly reset from when this manifest was last updated.  
+	 * 
+	 * **Note that this is only set after 30 minutes, at minimum, sometimes longer.**
+	 */
+	lastWeeklyReset: ISOString;
+	/**
+	 * A datetime string in the ISO format, yyyy-mm-ddThh:mm:ssZ, representing the last Trials reset from when this manifest was last updated.
+	 * When Trials is not active, this is the start of Trials on the previous week.
+	 * 
+	 * **Note that this does not take into account weeks when Trials is not active at all, such as when Iron Banner replaces it.**  
+	 * 
+	 * **Note that this is only set after 30 minutes, at minimum, sometimes longer.**
+	 */
+	lastTrialsReset: ISOString;
+
+	/**
+	 * The `instanceId` and `period` datetime of a PGCR created since the last daily reset. 
+	 * 
+	 * **Note that this is only set after 30 minutes, at minimum, sometimes longer.**
+	 * 
+	 * For reference, the PGCR chosen is generally not notable in any way, 
+	 * it's simply the first PGCR that a binary search happened to stumble upon in the correct day.
+	 */
+	referencePostGameCarnageReportSinceDailyReset: DeepsightManifestReferencePGCR;
+}
+
+export declare interface DeepsightManifestReferencePGCR {
+	instanceId: `${bigint}`;
+	period: ISOString;
+}
+
+export declare interface DeepsightDisplayPropertiesDefinition {
+	name?: string;
+	description?: string;
+	/**
+	 * Icon paths are guaranteed to either be via Bungie.net or deepsight.gg.
+	 * - Bungie.net icon paths always begin with `/` and should be appended to `https://www.bungie.net`
+	 * - deepsight.gg icon paths always begin with `./` should be joined with `https://deepsight.gg`
+	 */
+	icon?: DeepsightIconPath | BungieIconPath;
+}
+
+export declare type DeepsightIconPath = `./${string}`;
+export declare type BungieIconPath = `/${string}`;
+
+export declare interface DeepsightDropTableDefinition {
+	/**
+	 * `DestinyActivityDefinition` hash.
+	 * Refers to the version of the activity that's always available.
+	 */
+	hash: ActivityHashes;
+	/**
+	 * `DestinyActivityDefinition` hash.
+	 * Refers to the version of the activity that rotates in (if different.)
+	 * 
+	 * In the case of raids, this refers to the activity definition that lists all challenges available.
+	 */
+	rotationActivityHash?: ActivityHashes;
+	/**
+	 * Partial display properties. Not all fields are guaranteed to be provided.
+	 */
+	displayProperties?: DeepsightDisplayPropertiesDefinition;
+	/**
+	 * A drop table used as the base drop table for all encounters. Encounter-specific drop tables may override this.
+	 */
+	dropTable?: Partial<Record<InventoryItemHashes, DeepsightDropTableDropDefinition>>;
+	/**
+	 * If this activity has encounters, information about them will be here.
+	 */
+	encounters?: DeepsightDropTableEncounterDefinition[];
+	/**
+	 * If the activity has a high level variant which drops different loot, it's defined here.
+	 */
+	master?: DeepsightDropTableMasterDefinition;
+	/**
+	 * If challenges or drops rotate, this field will be filled.
+	 */
+	rotations?: DeepsightDropTableRotationsDefinition;
+
+	/**
+	 * If this activity is only available for a certain period of time, this specifies whether it's available as a rotator or whether it's a repeatable activity (IE, the most recent ones)
+	 */
+	availability?: "rotator" | "repeatable";
+	/**
+	 * A datetime string in the ISO format, yyyy-mm-ddThh:mm:ssZ, representing the time when this activity will no longer be available
+	 */
+	endTime?: ISOString;
+	/**
+	 * The type of activity as a string
+	 */
+	type: "nightfall" | "trials" | "dungeon" | "raid" | "lost-sector" | "exotic-mission";
+	/**
+	 * Partial display properties. Not all fields are guaranteed to be provided.
+	 */
+	typeDisplayProperties: DeepsightDisplayPropertiesDefinition;
+}
+
+export declare interface DeepsightDropTableEncounterDefinition {
+	/**
+	 * Phase hashes are based on data from `characterProgressions.milestones[milestone hash].activities[activity index].phases`
+	 */
+	phaseHash?: number;
+	/**
+	 * True if this is a traversal phase (not a real encounter)
+	 */
+	traversal?: true;
+	/**
+	 * Every encounter is guaranteed to have a partial display properties object.
+	 */
+	displayProperties: DeepsightDisplayPropertiesDefinition & {
+		/**
+		 * An alternative title for the encounter, generally wordier.
+		 */
+		directive?: string;
+	};
+	/**
+	 * Determines the way that this encounter's drop table should be applied to the base activity drop table.
+	 * - "replace" = this encounter-specific drop table should be used instead of the base drop table.
+	 * - "merge" = this encounter-specific drop table should be merged into the base drop table.
+	 * If not provided, it should default to "merge". 
+	 */
+	dropTableMergeStrategy?: "replace" | "merge";
+	/**
+	 * Encounter-specific drop table.
+	 */
+	dropTable?: Partial<Record<InventoryItemHashes, DeepsightDropTableDropDefinition>>;
+}
+
+export declare interface DeepsightDropTableMasterDefinition {
+	/**
+	 * `DestinyActivityDefinition` hash for the master activity.
+	 */
+	activityHash: ActivityHashes;
+	/**
+	 * A non-rotating drop table of items from the master activity.
+	 */
+	dropTable?: Partial<Record<InventoryItemHashes, DeepsightDropTableDropDefinition>>;
+	/**
+	 * If this activity is only available for a certain period of time, this specifies whether it's available as a rotator or whether it's a repeatable activity (IE, the most recent ones)
+	 */
+	availability?: "rotator" | "repeatable";
+}
+
+export declare interface DeepsightDropTableDropDefinition {
+	/**
+	 * `DestinyInventoryItemDefinition` hash representing a quest item required for this drop to drop.
+	 */
+	requiresQuest?: InventoryItemHashes;
+	/**
+	 * `DestinyInventoryItemDefinition` hashes representing a list of items required for this drop to drop.
+	 */
+	requiresItems?: InventoryItemHashes[];
+	/**
+	 * `true` if this item is only available for purchase in an end-of-activity cache.
+	 */
+	purchaseOnly?: true;
+}
+
+export declare interface DeepsightDropTableRotationsDefinition {
+	/**
+	 * A datetime string in the ISO format, yyyy-mm-ddThh:mm:ssZ, representing the time the rotations start from.
+	 */
+	anchor: ISOString;
+	/**
+	 * Whether this rotation is daily or weekly.
+	 */
+	interval: "daily" | "weekly";
+	/**
+	 * The current index into `drops`, `masterDrops`, and `challenges`. This will no longer be valid when the interval ends.
+	 * 
+	 * This can't be used directly as an index into the arrays, and must first be normalised to the respective array's length.
+	 * IE: `drops[current % drops.length]`
+	 */
+	current: number;
+	/**
+	 * A datetime string in the ISO format, yyyy-mm-ddThh:mm:ssZ, representing the time the current rotation will change to the next one.
+	 */
+	next: ISOString;
+	/**
+	 * An array of drop table objects (containing all possible drops) or `DestinyInventoryItemDefinition` hashes (for a single drop).
+	 * 
+	 * The first item in the array will be the active drop(s) during the week of the anchor reset, then the next drop the next week,
+	 * and so on until all drops are exhausted. At that point, it cycles back to the first drop.
+	 */
+	drops?: (Partial<Record<InventoryItemHashes, DeepsightDropTableDropDefinition>> | InventoryItemHashes)[];
+	/**
+	 *  An array of drop table objects (containing all possible drops) or `DestinyInventoryItemDefinition` hashes (for a single drop).
+	 * 
+	 * The first item in the array will be the active drop(s) during the week of the anchor reset, then the next drop the next week,
+	 * and so on until all drops are exhausted. At that point, it cycles back to the first drop.
+	 */
+	masterDrops?: (Partial<Record<InventoryItemHashes, DeepsightDropTableDropDefinition>> | InventoryItemHashes)[];
+	/**
+	 * `DestinyActivityModifierDefinition` hashes.
+	 * The first challenge will be the active challenge during the week of the anchor reset, then the next challenge the next week,
+	 * and so on until all challenges are exhausted. At that point, it cycles back to the first challenge.
+	 */
+	challenges?: ActivityModifierHashes[];
+}
+
+export declare interface DeepsightMomentDefinition {
+	hash: MomentHashes;
+	id: string;
+	displayProperties: DeepsightDisplayPropertiesDefinition;
+	iconWatermark?: string;
+	iconWatermarkShelved?: string;
+	/**
+	 * For events, the event card hash. If there isn't an event card, `true`
+	 */
+	event?: true | EventCardHashes;
+	expansion?: true;
+	season?: number;
+	year?: number;
+	seasonHash?: SeasonHashes;
+	/**
+	 * Items that should be associated with this moment, but aren't according to the Destiny manifest (by icon watermark).
+	 * You should render these items with this moment's `iconWatermark`.
+	 */
+	itemHashes?: InventoryItemHashes[];
+}
+
+/**
+ * Destiny 2 wallpapers Bungie has released indexed by `DeepsightMomentDefinition` hashes.
+ */
+export declare interface DeepsightWallpaperDefinition {
+	/**
+	 * A `DeepsightMomentDefinition` hash.
+	 */
+	hash: MomentHashes;
+	/**
+	 * Wallpaper URLs. Each is an absolute (full) URL.
+	 */
+	wallpapers: string[];
+}
+
+export interface DeepsightTierTypeDefinition {
+	/**
+	 * A `DestinyItemTierTypeDefinition` hash.
+	 */
+	hash: ItemTierTypeHashes;
+	/**
+	 * The `TierType` of this tier, as appears in `DestinyInventoryItemDefinition`'s `inventory.tierType`.
+	 */
+	tierType: TierType;
+	/**
+	 * Partial display properties. Not all fields are guaranteed to be provided.
+	 */
+	displayProperties: DeepsightDisplayPropertiesDefinition;
+}
+
+export interface DeepsightVendorDefinition {
+	/**
+	 * A `DestinyVendorDefinition` hash.
+	 */
+	hash: VendorHashes;
+	/**
+	 * Partial display properties. Not all fields are guaranteed to be provided.
+	 */
+	displayProperties: DeepsightDisplayPropertiesDefinition;
+	/**
+	 * The current location of the vendor.
+	 */
+	location: DestinyVendorLocationDefinition;
+	/**
+	 * An array of `DestinyVendorGroupDefinition` hashes.
+	 */
+	groups: VendorGroupHashes[];
+	categories: DeepsightVendorCategoryEntryDefinition[];
+}
+
+export interface DeepsightVendorCategoryEntryDefinition extends Omit<DestinyVendorCategoryEntryDefinition, "vendorItemIndexes"> {
+	items: DeepsightVendorItemDefinition[];
+}
+
+export interface DeepsightVendorItemDefinition extends DestinyVendorItemDefinition {
+	displayProperties: DestinyDisplayPropertiesDefinition;
+	quantity: number;
+	overrideNextRefreshDate?: string;
+	apiPurchasable?: boolean;
+	costs?: DestinyItemQuantity[];
+	itemComponent: { [KEY in keyof DestinyItemComponentSetOfint32]: DestinyItemComponentSetOfint32[KEY] extends DictionaryComponentResponse<infer T> ? T : never };
+}

package/README.md

@@ -0,0 +1,20 @@
+# deepsight.gg
+deepsight.gg provides a number of manifests generated automatically to make development with the Destiny 2 API easier.
+
+**The primary usage of this package is the TypeScript definitions.** That said, the current manifests do come with.
+
+**It's recommended to handle updating these manifests in the same way that you handle updating the Bungie.NET Destiny 2 manifest.** If you update the D2 manifest only when you can manually verify that your app works with it, update deepsight.gg manifests at the same time. If you instead keep it up to date on client machines or servers based on polling for version changes, you should do the same with the deepsight.gg manifests.
+
+If you use any of these manifests, please credit and link to [deepsight.gg](https://deepsight.gg)! It's not actually a requirement, but it would be super appreciated!
+
+## Live Updates
+The latest manifests are always available at `https://deepsight.gg/manifest/*`
+
+To only download when there's new versions, use [`versions.json`](https://deepsight.gg/manifest/versions.json). For more detail, see the [documentation](https://github.com/ChiriVulpes/deepsight.gg/wiki/Versions).
+
+## Manual Updates
+If you want to choose when to update to new versions of the deepsight.gg manifests manually, you have a few options:
+
+- If you want to be as manual as possible, you can just download the [`manifest` branch](https://github.com/ChiriVulpes/deepsight.gg/tree/manifest) directly.
+- You can add the [`manifest` branch](https://github.com/ChiriVulpes/deepsight.gg/tree/manifest) as a submodule.
+- You can use the manifests provided by this package!

package/package.json

@@ -0,0 +1,24 @@
+{
+	"name": "deepsight.gg",
+	"description": "Manifests provided by deepsight.gg, the next evolution of item management in Destiny 2.",
+	"version": "1.0.79",
+	"types": "Interfaces.d.ts",
+	"license": "MIT",
+	"keywords": [
+		"destiny2",
+		"destiny",
+		"deepsight",
+		"inventory",
+		"vault",
+		"bungie",
+		"bungie.net",
+		"typescript",
+		"item",
+		"api"
+	],
+	"homepage": "https://github.com/ChiriVulpes/deepsight.gg/wiki",
+	"author": "Chiri Vulpes",
+	"dependencies": {
+		"bungie-api-ts": "^5.0.0"
+	}
+}

package/versions.json

@@ -0,0 +1,20 @@
+{
+	"DeepsightDropTableDefinition": 36,
+	"DeepsightMomentDefinition": 2,
+	"DeepsightPlugCategorisation": 12,
+	"DeepsightWallpaperDefinition": 2,
+	"Enums": 10,
+	"Destiny2/Manifest": "222980.24.01.17.1915-1-bnet.53680",
+	"Interfaces": 7,
+	"deepsight": 79,
+	"DeepsightTierTypeDefinition": 1,
+	"lastDailyReset": "2024-01-25T17:00:00Z",
+	"lastWeeklyReset": "2024-01-23T17:00:00Z",
+	"lastTrialsReset": "2024-01-26T17:00:00Z",
+	"referencePostGameCarnageReportSinceDailyReset": {
+		"instanceId": "14371629904",
+		"period": "2024-01-25T19:15:32Z"
+	},
+	"updated": "2024-01-26T10:07:01Z",
+	"DeepsightVendorDefinition": 2
+}