Merge pull request #27 from JumpLink/master

Added themes api

.gitignore

@@ -42,6 +42,7 @@ tests/built/
 
 # Ignore private configuration files
 *.private.json
+.vscode
 
 # Ignore test project's yarn.lock
-tests/yarn.lock
+tests/yarn.lock

auth/index.ts

@@ -50,7 +50,7 @@ function buildHashString(type: "web" | "proxy", querystring: { [index: string]:
  * @param convertToBase64 Whether the resulting hash should be converted to base64 or left as hex. Should be true for validating webhook requests.
  */
 function getHmacHash(secretKey: string, hashString: string, convertToBase64 = false) {
-    let hash = crypto.HmacSHA256(hashString, secretKey); 
+    let hash: string | crypto.WordArray = crypto.HmacSHA256(hashString, secretKey); 
 
     if (convertToBase64) {
         hash = crypto.enc.Base64.stringify(hash);

models/base.ts

@@ -3,4 +3,8 @@ export interface ShopifyObject {
      * The object's unique id.
      */
     id?: number;
+    /**
+     * To help with migrating from our REST to the GraphQL, REST responses now include the GraphQL Admin API ID field, admin_graphql_api_id,. The ID in this field can be used to query the object directly using the GraphQL Admin API.
+     */
+    admin_graphql_api_id?: string;
 }

models/index.ts

@@ -36,6 +36,7 @@ export * from "./refund";
 export * from "./script_tag";
 export * from "./shipping_line";
 export * from "./shop";
+export * from "./theme";
 export * from "./tax_line";
 export * from "./transaction";
 export * from "./usage_charge";

models/theme.ts

@@ -0,0 +1,35 @@
+import { ShopifyObject } from "./base";
+
+export interface Theme extends ShopifyObject {
+    /**
+     * The name of the theme.
+     */
+    name?: string;
+    /**
+     * The date and time (ISO 8601 format) when the theme was created.
+     */
+    created_at?: string;
+    /**
+     * The date and time ( ISO 8601 format) when the theme was last updated.
+     */
+    updated_at?: string;
+    /**
+     * Specifies how the theme is being used within the shop. Valid values:
+     * * main: The theme is published. Customers see it when they visit the online store.
+     * * unpublished: The theme is unpublished. Customers can't see it.
+     * * demo: The theme is installed on the store as a demo. The theme can't be published until the merchant buys the full version.
+     */
+    role?: 'main' | 'unpublished' | 'demo';
+    /**
+     * A unique identifier applied to Shopify-made themes that are installed from the Shopify Theme Store Theme Store. Not all themes available in the Theme Store are developed by Shopify. Returns null if the store's theme isn't made by Shopify, or if it wasn't installed from the Theme Store.
+     */
+    theme_store_id?: number | null;
+    /**
+     * Whether the theme can currently be previewed.
+     */
+    previewable?: boolean;
+    /**
+     * Whether files are still being copied into place for this theme.
+     */
+    processing?: boolean;
+}

services/index.ts

@@ -20,5 +20,6 @@ export * from "./redirects";
 export * from "./script_tags";
 export * from "./shops";
 export * from "./smart_collections";
+export * from "./themes";
 export * from "./usage_charges";
 export * from "./webhooks";

services/themes.ts

@@ -0,0 +1,56 @@
+import * as Options from '../options';
+import { BaseService } from '../infrastructure';
+import { Theme } from '../models';
+
+/**
+ * A service for manipulating a Shopify shop's theme.
+ */
+export class Themes extends BaseService {
+    constructor(shopDomain: string, accessToken: string) {
+        super(shopDomain, accessToken, "themes");
+    }
+
+    /**
+     * Creates a theme by providing the public URL of a ZIP file that contains the theme.
+     * @param themes The theme being created.
+     */
+    public create(themes: Theme) {
+        return this.createRequest<Theme>("POST", `.json`, "", { themes });
+    }
+
+    /**
+     * Gets a tsingle hemes with the given id.
+     * @param id Id of the theme to retrieve.
+     * @param options Options for filtering the result.
+     */
+    public get(id: number, options?: Options.FieldOptions) {
+        return this.createRequest<Theme>("GET", `${id}.json`, "", options);
+    }
+
+    /**
+     * Updates an existing theme.
+     * @param id Id of the themes being updated.
+     * @param themes The updated theme.
+     */
+    public update(id: number, themes: Theme) {
+        return this.createRequest<Theme>("PUT", `${id}.json`, "themes", { themes });
+    }
+
+    /**
+     * Gets a list of all themes on the shop.
+     * @param options Options for filtering the results.
+     */
+    public list(options?: Options.FieldOptions) {
+        return this.createRequest<Theme[]>("GET", `.json`, "themes", options);
+    }
+
+    /**
+     * Deletes the themes with the given id.
+     * @param id Id of the theme being deleted.
+     */
+    public delete(id: number) {
+        return this.createRequest<void>("DELETE", `${id}.json`);
+    }
+}
+
+export default Themes;