https://github.com/quantumhousegames/deno-playfab-sdk

A collection of API modules, written in TypeScript, designed for use with Deno.
https://github.com/quantumhousegames/deno-playfab-sdk

deno playfab-apis playfab-sdk typescript

Last synced: about 1 month ago
JSON representation

A collection of API modules, written in TypeScript, designed for use with Deno.

• Host: GitHub
• URL: https://github.com/quantumhousegames/deno-playfab-sdk
• Owner: quantumhousegames
• License: apache-2.0
• Created: 2021-03-17T21:00:58.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-17T00:30:25.000Z (over 3 years ago)
• Last Synced: 2024-10-20T10:06:15.993Z (2 months ago)
• Topics: deno, playfab-apis, playfab-sdk, typescript
• Language: TypeScript
• Homepage: https://deno.land/x/playfab_sdk
• Size: 378 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PlayFab SDK for Deno

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/quantumhousegames/deno-playfab-sdk?label=version)](https://github.com/quantumhousegames/deno-playfab-sdk/releases)

A collection of API modules, written in TypeScript, designed for use with [Deno](https://deno.land). All the modules at the root are auto generated and based on the [API Specs](https://github.com/PlayFab/API_Specs/tree/master/Swagger/PlayFab) Provided by PlayFab. Each module exposes its related models as TypeScript interfaces, and all API operations are exposed as functions which return promises.

## Example

Let's say we wanted to use the [Add News feature of Title-Wide Data Manangement](https://docs.microsoft.com/en-us/rest/api/playfab/admin/title-wide-data-management/addnews?view=playfab-rest). We'd write the following code:

```typescript

import { AddNews } from "https://deno.land/x/playfab_sdk@VERSION/admin.ts";

const request = {

  Title: "My news title",

  Body: "My news body",

};

const options = {

  titleId: "YOUR_TITLE_ID",

  security: { SecretKey: "YOUR_SECRET_KEY" }

}

const result = await AddNews(request, options);

```

Note that the security option accepts only one of `SecretKey`, `EntityToken`, or `SessionTicket` per request. Additionally, some APIs do not require any security.

TIP: Always use a pinned version to ensure APIs don't change unexpectedly on you.

## Documentation

Each module comes with extensive focused documentation:

* [Admin](https://doc.deno.land/https/deno.land/x/playfab_sdk/admin.ts)

* [Authentication](https://doc.deno.land/https/deno.land/x/playfab_sdk/authentication.ts)

* [Client](https://doc.deno.land/https/deno.land/x/playfab_sdk/client.ts)

* [CloudScript](https://doc.deno.land/https/deno.land/x/playfab_sdk/cloudscript.ts)

* [Data](https://doc.deno.land/https/deno.land/x/playfab_sdk/data.ts)

* [Economy](https://doc.deno.land/https/deno.land/x/playfab_sdk/economy.ts)

* [Events](https://doc.deno.land/https/deno.land/x/playfab_sdk/client.ts)

* [Experimentation](https://doc.deno.land/https/deno.land/x/playfab_sdk/experimentation.ts)

* [Groups](https://doc.deno.land/https/deno.land/x/playfab_sdk/groups.ts)

* [Insights](https://doc.deno.land/https/deno.land/x/playfab_sdk/insights.ts)

* [Leaderboards](https://doc.deno.land/https/deno.land/x/playfab_sdk/leaderboards.ts)

* [Localization](https://doc.deno.land/https/deno.land/x/playfab_sdk/localization.ts)

* [Matchmaker](https://doc.deno.land/https/deno.land/x/playfab_sdk/matchmaker.ts)

* [Multiplayer](https://doc.deno.land/https/deno.land/x/playfab_sdk/multiplayer.ts)

* [Profiles](https://doc.deno.land/https/deno.land/x/playfab_sdk/profiles.ts)

* [Server](https://doc.deno.land/https/deno.land/x/playfab_sdk/server.ts)

## Updating the Generated APIs

This repo vendors in the [API Specs](https://github.com/PlayFab/API_Specs/tree/master/Swagger/PlayFab) project as a git submodule, so ensure it is fully initialized before starting.

From the root of this project run the following command:

```sh

deno run --allow-read --allow-write ./scripts/generate_apis.ts

```

### Versioning

The versioning of this repo will track the release versioning of the PlayFab SDK found here:

https://docs.microsoft.com/en-us/gaming/playfab/release-notes/

In the event that we need to fix a bug we will do point releases after that, for example: `210315.1`.

## Copyright and Licensing Information:

Apache License -- Version 2.0, January 2004 http://www.apache.org/licenses/

Full details available within the LICENSE file.