@nhost/stripe-graphql-js 0.0.3 → 0.0.5

package/dist/schema/subscription.js

@@ -14,37 +14,63 @@ const utils_1 = require("../utils");
 builder_1.builder.objectType('StripeSubscription', {
     description: '',
     fields: (t) => ({
-        id: t.exposeString('id'),
-        object: t.exposeString('object'),
+        id: t.exposeString('id', {
+            description: `Unique identifier for the object.`
+        }),
+        object: t.exposeString('object', {
+            description: `String representing the object's type. Objects of the same type share the same value.`
+        }),
         // todo: application
         applicationFeePercent: t.exposeFloat('application_fee_percent', {
+            description: `A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.`,
             nullable: true
         }),
         automaticTax: t.expose('automatic_tax', {
             type: 'StripeSubscriptionAutomaticTax'
         }),
-        billingCycleAnchor: t.exposeInt('billing_cycle_anchor'),
+        billingCycleAnchor: t.exposeInt('billing_cycle_anchor', {
+            description: `Determines the date of the first full invoice, and, for plans with \`month\` or \`year\` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.`
+        }),
         billingThresholds: t.expose('billing_thresholds', {
+            description: `Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period`,
             type: 'StripeSubscriptionBillingThresholds',
             nullable: true
         }),
         cancelAt: t.exposeInt('cancel_at', {
+            description: `A date in the future at which the subscription will automatically get canceled`,
             nullable: true
         }),
-        cancelAtPeriodEnd: t.exposeBoolean('cancel_at_period_end'),
+        cancelAtPeriodEnd: t.exposeBoolean('cancel_at_period_end', {
+            description: `If the subscription has been canceled with the \`at_period_end\` flag set to \`true\`, \`cancel_at_period_end\` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.`
+        }),
         canceledAt: t.exposeInt('canceled_at', {
+            description: `If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with \`cancel_at_period_end\`, \`canceled_at\` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.`,
             nullable: true
         }),
-        collectionMethods: t.exposeString('collection_method'),
-        created: t.exposeInt('created'),
-        currency: t.exposeString('currency'),
-        currentPeriodEnd: t.exposeInt('current_period_end'),
-        currentPeriodStart: t.exposeInt('current_period_start'),
-        customer: t.exposeString('customer'),
+        collectionMethods: t.exposeString('collection_method', {
+            description: `Either \`charge_automatically\`, or \`send_invoice\`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as \`active\`.`
+        }),
+        created: t.exposeInt('created', {
+            description: `Time at which the object was created. Measured in seconds since the Unix epoch.`
+        }),
+        currency: t.exposeString('currency', {
+            description: `Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).`
+        }),
+        currentPeriodEnd: t.exposeInt('current_period_end', {
+            description: `End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.`
+        }),
+        currentPeriodStart: t.exposeInt('current_period_start', {
+            description: `Start of the current period that the subscription has been invoiced for.`
+        }),
+        customer: t.exposeString('customer', {
+            description: `ID of the customer who owns the subscription.`
+        }),
         daysUntilDue: t.exposeInt('days_until_due', {
+            description: `Number of days a customer has to pay invoices generated by this subscription. This value will be \`null\` for subscriptions where \`collection_method=charge_automatically\`.`,
             nullable: true
         }),
         defaultPaymentMethod: t.field({
+            description: `ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over \`default_source\`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).`,
             type: 'StripePaymentMethod',
             nullable: true,
             resolve: (subscription) => __awaiter(void 0, void 0, void 0, function* () {
@@ -61,20 +87,25 @@ builder_1.builder.objectType('StripeSubscription', {
         }),
         // todo: default source
         defaultTaxRates: t.expose('default_tax_rates', {
+            description: `The tax rates that will apply to any subscription item that does not have \`tax_rates\` set. Invoices created will have their \`default_tax_rates\` populated from the subscription.`,
             type: ['StripeTaxRate'],
             nullable: true
         }),
         description: t.exposeString('description', {
+            description: `The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.`,
             nullable: true
         }),
         // TODO: discount
         endedAt: t.exposeInt('ended_at', {
+            description: `If the subscription has ended, the date the subscription ended.`,
             nullable: true
         }),
         items: t.expose('items', {
+            description: `List of subscription items, each with an attached price.`,
             type: 'StripeSubscriptionItems'
         }),
         latestInvoice: t.field({
+            description: `The most recent invoice this subscription has generated.`,
             type: 'StripeInvoice',
             nullable: true,
             resolve: (subscription) => __awaiter(void 0, void 0, void 0, function* () {
@@ -89,14 +120,19 @@ builder_1.builder.objectType('StripeSubscription', {
                 return invoice;
             })
         }),
-        livemode: t.exposeBoolean('livemode'),
+        livemode: t.exposeBoolean('livemode', {
+            description: `Has the value \`true\` if the object exists in live mode or the value \`false\` if the object exists in test mode.`
+        }),
         metadata: t.expose('metadata', {
+            description: `Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.`,
             type: 'JSON'
         }),
         nextPendingInvoiceItemInvoice: t.exposeInt('next_pending_invoice_item_invoice', {
+            description: `Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at \`pending_invoice_item_interval\`.`,
             nullable: true
         }),
         pauseCollection: t.expose('pause_collection', {
+            description: `If specified, payment collection for this subscription will be paused.`,
             type: 'StripeSubscriptionPauseCollection',
             nullable: true
         }),
@@ -105,9 +141,14 @@ builder_1.builder.objectType('StripeSubscription', {
         // todo: pending_setup_intent
         // todo: pending_update
         // todo: schedule
-        startDate: t.exposeInt('start_date'),
-        status: t.exposeString('status'),
+        startDate: t.exposeInt('start_date', {
+            description: `Date when the subscription was first created. The date might differ from the \`created\` date due to backdating.`
+        }),
+        status: t.exposeString('status', {
+            description: `Possible values are \`incomplete\`, \`incomplete_expired\`, \`trialing\`, \`active\`, \`past_due\`, \`canceled\`, or \`unpaid\`.\n\nFor \`collection_method=charge_automatically\` a subscription moves into \`incomplete\` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an \`active\` state. If the first invoice is not paid within 23 hours, the subscription transitions to \`incomplete_expired\`. This is a terminal state, the open invoice will be voided and no further invoices will be generated.\n\nA subscription that is currently in a trial period is \`trialing\` and moves to \`active\` when the trial period is over.\n\nIf subscription \`collection_method=charge_automatically\` it becomes \`past_due\` when payment to renew it fails and \`canceled\` or \`unpaid\` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.\n\nIf subscription \`collection_method=send_invoice\` it becomes \`past_due\` when its invoice is not paid by the due date, and \`canceled\` or \`unpaid\` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of \`unpaid\`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.`
+        }),
         testClock: t.field({
+            description: `ID of the test clock this subscription belongs to.`,
             type: 'StripeTestClock',
             nullable: true,
             resolve: (subscription) => __awaiter(void 0, void 0, void 0, function* () {
@@ -124,9 +165,11 @@ builder_1.builder.objectType('StripeSubscription', {
         }),
         // todo: transfer data
         trialEnd: t.exposeInt('trial_end', {
+            description: `If the subscription has a trial, the end of that trial.`,
             nullable: true
         }),
         trialStart: t.exposeInt('trial_start', {
+            description: `If the subscription has a trial, the beginning of that trial.`,
             nullable: true
         })
     })

package/dist/schema/subscription.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../src/schema/subscription.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,wCAAoC;AAEpC,oCAAiC;AAEjC,iBAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE;IACvC,WAAW,EAAE,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC;QACxB,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC;QAChC,oBAAoB;QACpB,qBAAqB,EAAE,CAAC,CAAC,WAAW,CAAC,yBAAyB,EAAE;YAC9D,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE;YACtC,IAAI,EAAE,gCAAgC;SACvC,CAAC;QACF,kBAAkB,EAAE,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC;QACvD,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,oBAAoB,EAAE;YAChD,IAAI,EAAE,qCAAqC;YAC3C,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;YACjC,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,sBAAsB,CAAC;QAC1D,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,EAAE;YACrC,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,iBAAiB,EAAE,CAAC,CAAC,YAAY,CAAC,mBAAmB,CAAC;QACtD,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;QAC/B,QAAQ,EAAE,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC;QACpC,gBAAgB,EAAE,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC;QACnD,kBAAkB,EAAE,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC;QACvD,QAAQ,EAAE,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC;QACpC,YAAY,EAAE,CAAC,CAAC,SAAS,CAAC,gBAAgB,EAAE;YAC1C,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,oBAAoB,EAAE,CAAC,CAAC,KAAK,CAAC;YAC5B,IAAI,EAAE,qBAAqB;YAC3B,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAO,YAAY,EAAE,EAAE;gBAC9B,MAAM,EAAE,sBAAsB,EAAE,GAAG,YAAY,CAAA;gBAC/C,IAAI,CAAC,sBAAsB,EAAE;oBAC3B,OAAO,IAAI,CAAA;iBACZ;gBAED,MAAM,aAAa,GAAG,MAAM,cAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,sBAAgC,CAAC,CAAA;gBAE5F,IAAI,CAAC,aAAa,EAAE;oBAClB,OAAO,IAAI,CAAA;iBACZ;gBAED,OAAO,aAAoC,CAAA;YAC7C,CAAC,CAAA;SACF,CAAC;QACF,uBAAuB;QACvB,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,mBAAmB,EAAE;YAC7C,IAAI,EAAE,CAAC,eAAe,CAAC;YACvB,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE;YACzC,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,iBAAiB;QACjB,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE;YAC/B,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE;YACvB,IAAI,EAAE,yBAAyB;SAChC,CAAC;QACF,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC;YACrB,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAO,YAAY,EAAE,EAAE;gBAC9B,MAAM,EAAE,cAAc,EAAE,GAAG,YAAY,CAAA;gBACvC,IAAI,CAAC,cAAc,EAAE;oBACnB,OAAO,IAAI,CAAA;iBACZ;gBAED,MAAM,OAAO,GAAG,MAAM,cAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAwB,CAAC,CAAA;gBAExE,IAAI,CAAC,OAAO,EAAE;oBACZ,OAAO,IAAI,CAAA;iBACZ;gBAED,OAAO,OAAwB,CAAA;YACjC,CAAC,CAAA;SACF,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QACrC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;YAC7B,IAAI,EAAE,MAAM;SACb,CAAC;QACF,6BAA6B,EAAE,CAAC,CAAC,SAAS,CAAC,mCAAmC,EAAE;YAC9E,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE;YAC5C,IAAI,EAAE,mCAAmC;YACzC,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,yBAAyB;QACzB,sCAAsC;QACtC,6BAA6B;QAC7B,uBAAuB;QACvB,iBAAiB;QACjB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC;QACpC,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC;QAChC,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC;YACjB,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAO,YAAY,EAAE,EAAE;gBAC9B,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,CAAA;gBAEnC,IAAI,CAAC,UAAU,EAAE;oBACf,OAAO,IAAI,CAAA;iBACZ;gBAED,MAAM,SAAS,GAAG,MAAM,cAAM,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAoB,CAAC,CAAA;gBAEpF,IAAI,CAAC,SAAS,EAAE;oBACd,OAAO,IAAI,CAAA;iBACZ;gBAED,OAAO,SAAS,CAAA;YAClB,CAAC,CAAA;SACF,CAAC;QACF,sBAAsB;QACtB,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;YACjC,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,EAAE;YACrC,QAAQ,EAAE,IAAI;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAA"}
+{"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../src/schema/subscription.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,wCAAoC;AAEpC,oCAAiC;AAEjC,iBAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE;IACvC,WAAW,EAAE,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE;YACvB,WAAW,EAAE,mCAAmC;SACjD,CAAC;QACF,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC/B,WAAW,EAAE,uFAAuF;SACrG,CAAC;QACF,oBAAoB;QACpB,qBAAqB,EAAE,CAAC,CAAC,WAAW,CAAC,yBAAyB,EAAE;YAC9D,WAAW,EAAE,oNAAoN;YACjO,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE;YACtC,IAAI,EAAE,gCAAgC;SACvC,CAAC;QACF,kBAAkB,EAAE,CAAC,CAAC,SAAS,CAAC,sBAAsB,EAAE;YACtD,WAAW,EAAE,mLAAmL;SACjM,CAAC;QACF,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,oBAAoB,EAAE;YAChD,WAAW,EAAE,2GAA2G;YACxH,IAAI,EAAE,qCAAqC;YAC3C,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;YACjC,WAAW,EAAE,gFAAgF;YAC7F,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,sBAAsB,EAAE;YACzD,WAAW,EAAE,4SAA4S;SAC1T,CAAC;QACF,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,EAAE;YACrC,WAAW,EAAE,yTAAyT;YACtU,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,iBAAiB,EAAE,CAAC,CAAC,YAAY,CAAC,mBAAmB,EAAE;YACrD,WAAW,EAAE,mVAAmV;SACjW,CAAC;QACF,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE;YAC9B,WAAW,EAAE,iFAAiF;SAC/F,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE;YACnC,WAAW,EAAE,uKAAuK;SACrL,CAAC;QACF,gBAAgB,EAAE,CAAC,CAAC,SAAS,CAAC,oBAAoB,EAAE;YAClD,WAAW,EAAE,kIAAkI;SAChJ,CAAC;QACF,kBAAkB,EAAE,CAAC,CAAC,SAAS,CAAC,sBAAsB,EAAE;YACtD,WAAW,EAAE,0EAA0E;SACxF,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE;YACnC,WAAW,EAAE,+CAA+C;SAC7D,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,SAAS,CAAC,gBAAgB,EAAE;YAC1C,WAAW,EAAE,+KAA+K;YAC5L,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,oBAAoB,EAAE,CAAC,CAAC,KAAK,CAAC;YAC5B,WAAW,EAAE,+cAA+c;YAC5d,IAAI,EAAE,qBAAqB;YAC3B,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAO,YAAY,EAAE,EAAE;gBAC9B,MAAM,EAAE,sBAAsB,EAAE,GAAG,YAAY,CAAA;gBAC/C,IAAI,CAAC,sBAAsB,EAAE;oBAC3B,OAAO,IAAI,CAAA;iBACZ;gBAED,MAAM,aAAa,GAAG,MAAM,cAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,sBAAgC,CAAC,CAAA;gBAE5F,IAAI,CAAC,aAAa,EAAE;oBAClB,OAAO,IAAI,CAAA;iBACZ;gBAED,OAAO,aAAoC,CAAA;YAC7C,CAAC,CAAA;SACF,CAAC;QACF,uBAAuB;QACvB,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,mBAAmB,EAAE;YAC7C,WAAW,EAAE,sLAAsL;YACnM,IAAI,EAAE,CAAC,eAAe,CAAC;YACvB,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE;YACzC,WAAW,EAAE,kLAAkL;YAC/L,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,iBAAiB;QACjB,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE;YAC/B,WAAW,EAAE,iEAAiE;YAC9E,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE;YACvB,WAAW,EAAE,0DAA0D;YACvE,IAAI,EAAE,yBAAyB;SAChC,CAAC;QACF,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC;YACrB,WAAW,EAAE,0DAA0D;YACvE,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAO,YAAY,EAAE,EAAE;gBAC9B,MAAM,EAAE,cAAc,EAAE,GAAG,YAAY,CAAA;gBACvC,IAAI,CAAC,cAAc,EAAE;oBACnB,OAAO,IAAI,CAAA;iBACZ;gBAED,MAAM,OAAO,GAAG,MAAM,cAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAwB,CAAC,CAAA;gBAExE,IAAI,CAAC,OAAO,EAAE;oBACZ,OAAO,IAAI,CAAA;iBACZ;gBAED,OAAO,OAAwB,CAAA;YACjC,CAAC,CAAA;SACF,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,EAAE;YACpC,WAAW,EAAE,oHAAoH;SAClI,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;YAC7B,WAAW,EAAE,iMAAiM;YAC9M,IAAI,EAAE,MAAM;SACb,CAAC;QACF,6BAA6B,EAAE,CAAC,CAAC,SAAS,CAAC,mCAAmC,EAAE;YAC9E,WAAW,EAAE,gKAAgK;YAC7K,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE;YAC5C,WAAW,EAAE,wEAAwE;YACrF,IAAI,EAAE,mCAAmC;YACzC,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,yBAAyB;QACzB,sCAAsC;QACtC,6BAA6B;QAC7B,uBAAuB;QACvB,iBAAiB;QACjB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,YAAY,EAAE;YACnC,WAAW,EAAE,kHAAkH;SAChI,CAAC;QACF,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC/B,WAAW,EAAE,69CAA69C;SAC3+C,CAAC;QACF,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC;YACjB,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAO,YAAY,EAAE,EAAE;gBAC9B,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,CAAA;gBAEnC,IAAI,CAAC,UAAU,EAAE;oBACf,OAAO,IAAI,CAAA;iBACZ;gBAED,MAAM,SAAS,GAAG,MAAM,cAAM,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAoB,CAAC,CAAA;gBAEpF,IAAI,CAAC,SAAS,EAAE;oBACd,OAAO,IAAI,CAAA;iBACZ;gBAED,OAAO,SAAS,CAAA;YAClB,CAAC,CAAA;SACF,CAAC;QACF,sBAAsB;QACtB,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;YACjC,WAAW,EAAE,yDAAyD;YACtE,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,EAAE;YACrC,WAAW,EAAE,+DAA+D;YAC5E,QAAQ,EAAE,IAAI;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAA"}

package/dist/schema/subscriptions.js

@@ -4,8 +4,12 @@ const builder_1 = require("../builder");
 builder_1.builder.objectType('StripeSubscriptions', {
     fields: (t) => ({
         object: t.exposeString('object'),
-        url: t.exposeString('url'),
-        hasMore: t.exposeBoolean('has_more'),
+        url: t.exposeString('url', {
+            description: `The URL where this list can be accessed.`
+        }),
+        hasMore: t.exposeBoolean('has_more', {
+            description: `True if this list has another page of items after this one that can be fetched.`
+        }),
         data: t.expose('data', {
             type: ['StripeSubscription'],
             nullable: false

package/dist/schema/subscriptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/schema/subscriptions.ts"],"names":[],"mappings":";;AAAA,wCAAoC;AAEpC,iBAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC;QAChC,GAAG,EAAE,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;QAC1B,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QACpC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,CAAC,oBAAoB,CAAC;YAC5B,QAAQ,EAAE,KAAK;SAChB,CAAC;KACH,CAAC;CACH,CAAC,CAAA"}
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/schema/subscriptions.ts"],"names":[],"mappings":";;AAAA,wCAAoC;AAEpC,iBAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC;QAChC,GAAG,EAAE,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE;YACzB,WAAW,EAAE,0CAA0C;SACxD,CAAC;QACF,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,EAAE;YACnC,WAAW,EAAE,iFAAiF;SAC/F,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,CAAC,oBAAoB,CAAC;YAC5B,QAAQ,EAAE,KAAK;SAChB,CAAC;KACH,CAAC;CACH,CAAC,CAAA"}

package/dist/schema/test-clock.js

@@ -4,16 +4,31 @@ const builder_1 = require("../builder");
 builder_1.builder.objectType('StripeTestClock', {
     description: '',
     fields: (t) => ({
-        id: t.exposeString('id'),
-        object: t.exposeString('object'),
-        created: t.exposeInt('created'),
-        deletesAfter: t.exposeInt('deletes_after'),
-        frozenTime: t.exposeInt('frozen_time'),
-        livemode: t.exposeBoolean('livemode'),
+        id: t.exposeString('id', {
+            description: `Unique identifier for the object.`
+        }),
+        object: t.exposeString('object', {
+            description: `String representing the object's type. Objects of the same type share the same value.`
+        }),
+        created: t.exposeInt('created', {
+            description: `Time at which the object was created. Measured in seconds since the Unix epoch.`
+        }),
+        deletesAfter: t.exposeInt('deletes_after', {
+            description: `Time at which this clock is scheduled to auto delete.`
+        }),
+        frozenTime: t.exposeInt('frozen_time', {
+            description: `Time at which all objects belonging to this clock are frozen.`
+        }),
+        livemode: t.exposeBoolean('livemode', {
+            description: `Has the value \`true\` if the object exists in live mode or the value \`false\` if the object exists in test mode.`
+        }),
         name: t.exposeString('name', {
+            description: `The custom name supplied at creation.`,
             nullable: true
         }),
-        status: t.exposeString('status')
+        status: t.exposeString('status', {
+            description: `The status of the Test Clock.`
+        })
     })
 });
 //# sourceMappingURL=test-clock.js.map

package/dist/schema/test-clock.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-clock.js","sourceRoot":"","sources":["../../src/schema/test-clock.ts"],"names":[],"mappings":";;AAAA,wCAAoC;AAEpC,iBAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE;IACpC,WAAW,EAAE,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC;QACxB,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC;QAChC,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;QAC/B,YAAY,EAAE,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC;QAC1C,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC;QACtC,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QACrC,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE;YAC3B,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC;KACjC,CAAC;CACH,CAAC,CAAA"}
+{"version":3,"file":"test-clock.js","sourceRoot":"","sources":["../../src/schema/test-clock.ts"],"names":[],"mappings":";;AAAA,wCAAoC;AAEpC,iBAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE;IACpC,WAAW,EAAE,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE;YACvB,WAAW,EAAE,mCAAmC;SACjD,CAAC;QACF,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC/B,WAAW,EAAE,uFAAuF;SACrG,CAAC;QACF,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE;YAC9B,WAAW,EAAE,iFAAiF;SAC/F,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,SAAS,CAAC,eAAe,EAAE;YACzC,WAAW,EAAE,uDAAuD;SACrE,CAAC;QACF,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,EAAE;YACrC,WAAW,EAAE,+DAA+D;SAC7E,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,EAAE;YACpC,WAAW,EAAE,oHAAoH;SAClI,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE;YAC3B,WAAW,EAAE,uCAAuC;YACpD,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC/B,WAAW,EAAE,+BAA+B;SAC7C,CAAC;KACH,CAAC;CACH,CAAC,CAAA"}

package/dist/types.d.ts

@@ -1,14 +1,14 @@
 import type Stripe from 'stripe';
 import type { CORSOptions, YogaInitialContext } from '@graphql-yoga/node';
 export declare type StripeGraphQLContext = {
-    isAllowed: (stripeCustomerId: string, context: Context) => boolean;
+    isAllowed: (stripeCustomerId: string, context: Context) => boolean | Promise<boolean>;
     userClaims?: UserHasuraClaims;
     isAdmin: boolean;
 };
 export declare type Context = YogaInitialContext & StripeGraphQLContext;
 export declare type CreateServerProps = {
     cors?: CORSOptions;
-    isAllowed?: (stripeCustomerId: string, context: Context) => boolean;
+    isAllowed?: (stripeCustomerId: string, context: Context) => boolean | Promise<boolean>;
     graphiql?: boolean;
 };
 export declare type StripePaymentMethod = Stripe.PaymentMethod & {

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAEhC,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEzE,oBAAY,oBAAoB,GAAG;IACjC,SAAS,EAAE,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAA;IAClE,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,oBAAY,OAAO,GAAG,kBAAkB,GAAG,oBAAoB,CAAA;AAE/D,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAA;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAID,oBAAY,mBAAmB,GAAG,MAAM,CAAC,aAAa,GAAG;IACvD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,oBAAY,kBAAkB,GAAG,MAAM,CAAC,YAAY,GAAG;IACrD,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,CAAA;AAED,oBAAY,aAAa,GAAG,MAAM,CAAC,OAAO,GAAG;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,sBAAsB,EAAE,mBAAmB,GAAG,IAAI,CAAA;CACnD,CAAA;AAED,oBAAY,gBAAgB,GAAG;IAC7B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,uBAAuB,EAAE,MAAM,CAAA;IAC/B,wBAAwB,EAAE,MAAM,EAAE,CAAA;CACnC,GAAG;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAEhC,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEzE,oBAAY,oBAAoB,GAAG;IACjC,SAAS,EAAE,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACrF,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,oBAAY,OAAO,GAAG,kBAAkB,GAAG,oBAAoB,CAAA;AAE/D,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,SAAS,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACtF,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAID,oBAAY,mBAAmB,GAAG,MAAM,CAAC,aAAa,GAAG;IACvD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,oBAAY,kBAAkB,GAAG,MAAM,CAAC,YAAY,GAAG;IACrD,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,CAAA;AAED,oBAAY,aAAa,GAAG,MAAM,CAAC,OAAO,GAAG;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,sBAAsB,EAAE,mBAAmB,GAAG,IAAI,CAAA;CACnD,CAAA;AAED,oBAAY,gBAAgB,GAAG;IAC7B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,uBAAuB,EAAE,MAAM,CAAA;IAC/B,wBAAwB,EAAE,MAAM,EAAE,CAAA;CACnC,GAAG;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhost/stripe-graphql-js",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Stripe GraphQL API",
   "license": "MIT",
   "keywords": [
@@ -53,6 +53,5 @@
     "lint:fix": "eslint . --ext .ts,.tsx --fix",
     "verify": "run-p prettier lint",
     "verify:fix": "run-p prettier:fix lint:fix"
-  },
-  "readme": "<h1 align=\"center\">@nhost/stripe-graphql-js</h1>\n<h2 align=\"center\">Stripe GraphQL API</h2>\n\n<p align=\"center\">\n  <img alt=\"npm\" src=\"https://img.shields.io/npm/v/@nhost/stripe-graphql\">\n  <img alt=\"npm\" src=\"https://img.shields.io/npm/dm/@nhost/stripe-graphql\">\n  <a href=\"LICENSE\">\n    <img src=\"https://img.shields.io/badge/license-MIT-yellow.svg\" alt=\"license: MIT\" />\n  </a>\n</p>\n\nThis package creates a Stripe GraphQL API.\n\n```graphql\nquery {\n  stripe {\n    customer(id: \"cus_MVBRpmnBis9v5x\") {\n      id\n      name\n      invoices {\n        data {\n          id\n          created\n          paid\n          hostedInvoiceUrl\n        }\n      }\n    }\n  }\n}\n```\n\nYou can also add the Stripe GraphQL API as a Hasura Remote Schema and connect data from your database and Stripe. This allows you to request data from your database and Stripe in a single GraphQL query:\n\n```graphql\nquery {\n  users {\n    # User in your database\n    id\n    displayName\n    userData {\n      stripeCustomerId # Customer's Stripe Customer Id\n      stripeCustomer {\n        # Data from Stripe\n        id\n        name\n        paymentMethods {\n          id\n          card {\n            brand\n            last4\n          }\n        }\n      }\n    }\n  }\n}\n```\n\n## Install\n\n```bash\nnpm install @nhost/stripe-graphql-js\n```\n\n## Quick Start\n\n### Serverless Function Setup\n\nCreate a new [Serverless Function](https://docs.nhost.io/platform/serverless-functions) `functions/graphql/stripe.ts`:\n\n```js\nimport { createStripeGraphQLServer } from '@nhost/stripe-graphql-js'\n\nconst server = createStripeGraphQLServer()\n\nexport default server\n```\n\n> You can run the Stripe GraphQL API in any JS environment because it's built using [GraphQL Yoga](https://github.com/dotansimha/graphql-yoga).\n\n### Test\n\nTest the Stripe GraphQL API in the browser:\n\n[http://localhost:1337/v1/functions/graphql/stripe](http://localhost:1337/v1/functions/graphql/stripe)\n\n### Remote Schema\n\nAdd the Stripe GraphQL API as a Remote Schema in Hasura.\n\n**URL**\n\n```\n{{NHOST_BACKEND_URL}}/v1/functions/graphql/stripe`\n```\n\n**Headers**\n\n```\nx-nhost-webhook-secret: NHOST_WEBHOOK_SECRET (from env var)\n```\n\n![Hasura Remote Schema](./assets//hasura-remote-schema.png)\n\n## Permissions\n\nHere's a minimal example without any custom permissions. Only requests using the `x-hasura-admin-secret` header will work:\n\n```js\nconst server = createStripeGraphQLServer()\n```\n\nFor more granular permissions, you can pass an `isAllowed` function to the `createStripeGraphQLServer`. The `isAllowed` function takes a `stripeCustomerId` and [`context`](#context) as parameters and runs every time the GraphQL server makes a request to Stripe to get or modify data for a specific Stripe customer.\n\nHere is an example of an `isAllowed` function:\n\n```js\n\nconst isAllowed = (stripeCustomerId: string, context: Context) => {\n  const { isAdmin, userClaims } = context\n\n  // allow requests if it has a valid `x-hasura-admin-secret`\n  if (isAdmin) {\n    return true\n  }\n\n  // get user id\n  const userId = userClaims['x-hasura-user-id']\n\n  // check if user is signed in\n  if (!userId) {\n    return false;\n  }\n\n  // get more user information from the database\n  const { user } = await gqlSDK.getUser({\n    id: userId,\n  });\n\n  if (!user) {\n    return false;\n  }\n\n  // check if the user is part of a workspace with the `stripeCustomerId`\n  return user.workspaceMembers\n    .some((workspaceMember) => {\n      return workspaceMember.workspace.stripeCustomerId === stripeCustomerId;\n    });\n}\n\n```\n\n### Context\n\nThe `context` object contains:\n\n- `userClaims` - verified JWT claims from the user's access token.\n- `isAdmin` - `true` if the request was made using a valid `x-hasura-admin-secret` header.\n- `request` - [Fetch API Request object](https://developer.mozilla.org/en-US/docs/Web/API/Request) that represents the incoming HTTP request in platform-independent way. It can be useful for accessing headers to authenticate a user\n- `query` - the DocumentNode that was parsed from the GraphQL query string\n- `operationName` - the operation name selected from the incoming query\n- `variables` - the variables that were defined in the query\n- `extensions` - the extensions that were received from the client\n\nRead more about the [default context from GraphQL Yoga](https://www.the-guild.dev/graphql/yoga-server/docs/features/context#default-context).\n\n## Development\n\nInstall dependencies:\n\n```bash\npnpm install\n```\n\nStart the development server:\n\n```bash\npnpm dev\n```\n\nThe GraphQL Server will reload every time the code changes.\n\nOpen GraphiQL:\n\n[http://0.0.0.0:4000/graphql](http://0.0.0.0:4000/graphql)\n"
+  }
 }