@aglyn/aglyn 1.24.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +11 -11
- package/src/lib/app-utils/activity-labels.js +4 -1
- package/src/lib/app-utils/activity-labels.js.map +1 -1
- package/src/lib/app-utils/business-details.d.ts +5 -0
- package/src/lib/app-utils/business-details.js +4 -0
- package/src/lib/app-utils/business-details.js.map +1 -1
- package/src/lib/app-utils/crm.d.ts +17 -30
- package/src/lib/app-utils/crm.js +139 -3
- package/src/lib/app-utils/crm.js.map +1 -1
- package/src/lib/app-utils/docs-help-sections.generated.js +4 -1
- package/src/lib/app-utils/docs-help-sections.generated.js.map +1 -1
- package/src/lib/app-utils/docs-help.generated.d.ts +1 -1
- package/src/lib/app-utils/docs-help.generated.js +7 -0
- package/src/lib/app-utils/docs-help.generated.js.map +1 -1
- package/src/lib/app-utils/docs-index.generated.js +28 -7
- package/src/lib/app-utils/docs-index.generated.js.map +1 -1
- package/src/lib/app-utils/host-tokens.d.ts +17 -0
- package/src/lib/app-utils/host-tokens.js +18 -0
- package/src/lib/app-utils/host-tokens.js.map +1 -1
- package/src/lib/app-utils/native-app-association.d.ts +5 -3
- package/src/lib/app-utils/native-app-association.js +5 -3
- package/src/lib/app-utils/native-app-association.js.map +1 -1
- package/src/lib/app-utils/native-nav.js +1 -1
- package/src/lib/app-utils/native-nav.js.map +1 -1
- package/src/lib/app-utils/plan-entitlements.d.ts +227 -36
- package/src/lib/app-utils/plan-entitlements.js +335 -43
- package/src/lib/app-utils/plan-entitlements.js.map +1 -1
- package/src/lib/app-utils/reusable-component-keys.d.ts +9 -0
- package/src/lib/app-utils/reusable-component-keys.js +9 -0
- package/src/lib/app-utils/reusable-component-keys.js.map +1 -1
- package/src/lib/app-utils/server.d.ts +1 -0
- package/src/lib/app-utils/server.js +1 -0
- package/src/lib/app-utils/server.js.map +1 -1
- package/src/lib/app-utils/sign-in-visibility.d.ts +78 -0
- package/src/lib/app-utils/sign-in-visibility.js +79 -0
- package/src/lib/app-utils/sign-in-visibility.js.map +1 -0
- package/src/lib/app-utils/site-live-url.d.ts +4 -1
- package/src/lib/app-utils/site-live-url.js +17 -3
- package/src/lib/app-utils/site-live-url.js.map +1 -1
- package/src/lib/app-utils/usage-level.d.ts +50 -0
- package/src/lib/app-utils/usage-level.js +94 -0
- package/src/lib/app-utils/usage-level.js.map +1 -0
- package/src/lib/foundation/definitions/org-billing.types.d.ts +24 -2
- package/src/lib/foundation/definitions/org-billing.types.js.map +1 -1
|
@@ -2643,6 +2643,27 @@ export const DOCS_SECTION_INDEX = [
|
|
|
2643
2643
|
anchor: '#related',
|
|
2644
2644
|
text: '- Copy & paste elements\n- The Besigner\n- Pages & layouts\n- Generate a reusable component with Aglyn AI'
|
|
2645
2645
|
},
|
|
2646
|
+
{
|
|
2647
|
+
path: '/building-sites/besigner/show-to-signed-in-visitors',
|
|
2648
|
+
title: 'Show to signed-in or signed-out visitors',
|
|
2649
|
+
heading: '',
|
|
2650
|
+
anchor: '',
|
|
2651
|
+
text: 'Show to signed-in or signed-out visitors\nWhen your site has accounts, some things are for members and some are for everyone else: Sign in in the header for visitors and Account once they have signed in, a "Create an account" banner only for people who have not, a "Welcome back" only for those who have.'
|
|
2652
|
+
},
|
|
2653
|
+
{
|
|
2654
|
+
path: '/building-sites/besigner/show-to-signed-in-visitors',
|
|
2655
|
+
title: 'Show to signed-in or signed-out visitors',
|
|
2656
|
+
heading: 'Choose who sees an element',
|
|
2657
|
+
anchor: '#choose-who-sees-an-element',
|
|
2658
|
+
text: '1. Select the element on the canvas.\n2. In the Attributes panel, find Show to.\n3. Pick Signed-in visitors or Signed-out visitors. Everyone is the default.\nFor a header that says "Sign in" to visitors and "Account" to members, put two buttons side by side: set the "Sign in" button to Signed-out visitors and the "Account" button to Signed-in visitors. Both can open your account page, which shows the sign-in form to anyone who is not signed in yet.'
|
|
2659
|
+
},
|
|
2660
|
+
{
|
|
2661
|
+
path: '/building-sites/besigner/show-to-signed-in-visitors',
|
|
2662
|
+
title: 'Show to signed-in or signed-out visitors',
|
|
2663
|
+
heading: 'What visitors see',
|
|
2664
|
+
anchor: '#what-visitors-see',
|
|
2665
|
+
text: 'The live site decides as the page loads, so a visitor never sees the wrong button appear and disappear. Signing in or out on the account page updates the page straight away.\nIn the Besigner every element shows, whatever its Show to, so you can select and edit both versions.\nIt hides, it does not protect Show to decides what is shown, not who may see it: the content is still in the page. For content only members may read, use a members-only page.'
|
|
2666
|
+
},
|
|
2646
2667
|
{
|
|
2647
2668
|
path: '/building-sites/besigner/text-editing',
|
|
2648
2669
|
title: 'Inline & rich text editing',
|
|
@@ -8633,7 +8654,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
8633
8654
|
title: 'Forms & Lead Capture',
|
|
8634
8655
|
heading: 'Where submissions go',
|
|
8635
8656
|
anchor: '#where-submissions-go',
|
|
8636
|
-
text: '- Inbox — every submission is captured; open it in the console\'s mail reader dialog.\n- Datasets — bind a form to a dataset (Write to dataset on the Form element) and each submission is also appended as a record. The inbox always gets its copy, and each submission\'s own detail dialog carries chips saying where it went — including saying nothing about a dataset when the record wasn\'t created.\n- Contacts — every submission that carries an email address updates the person in the CRM at stage Lead: a new contact when the address is new, an interaction on their timeline when it is not, and a customer stays a customer. A field can also save its answer into one of your custom contact fields — pick the field under Saves to contact fields on the form\'s own page.\n- Leads — only when the form\'s CRM routing card has the lead switch on. See What makes a lead.\nThe inbox\nThe site\'s Inbox page collects everything visitors send, in three tabs — Submissions, Members & leads, and Campaigns. The Form Submissions table reads as a list of people, not of forms: From, Message, Received, and the row actions.\n- From shows the sender — a colored initials avatar and their name, with the form name as a caption underneath (the Form element\'s Form name attribute, so name your forms distinctly: "Contact", "Newsletter", "Survey"). The avatar\'s color is derived from the name, so one sender keeps one color on every machine.\n- Unread submissions are bold with a dot at the left of the row. There is no "New" chip — bold text and a chip saying New are the same fact twice. Site managers
|
|
8657
|
+
text: '- Inbox — every submission is captured; open it in the console\'s mail reader dialog.\n- Datasets — bind a form to a dataset (Write to dataset on the Form element) and each submission is also appended as a record. The inbox always gets its copy, and each submission\'s own detail dialog carries chips saying where it went — including saying nothing about a dataset when the record wasn\'t created.\n- Contacts — every submission that carries an email address updates the person in the CRM at stage Lead: a new contact when the address is new, an interaction on their timeline when it is not, and a customer stays a customer. A field can also save its answer into one of your custom contact fields — pick the field under Saves to contact fields on the form\'s own page.\n- Leads — only when the form\'s CRM routing card has the lead switch on. See What makes a lead.\nOn Free, which keeps up to 100 people for the CRM, a submission past that is still saved in the inbox and the visitor sees the normal confirmation, but no new contact or lead is made from it, now or later — see CRM records.\nThe inbox\nThe site\'s Inbox page collects everything visitors send, in three tabs — Submissions, Members & leads, and Campaigns. The Form Submissions table reads as a list of people, not of forms: From, Message, Received, and the row actions.\n- From shows the sender — a colored initials avatar and their name, with the form name as a caption underneath (the Form element\'s Form name attribute, so name your forms distinctly: "Contact", "Newsletter", "Survey"). The avatar\'s color is derived from the name, so one sender keeps one color on every machine.\n- Unread submissions are bold with a dot at the left of the row. There is no "New" chip — bold text and a chip saying New are the same fact twice. Site managers als'
|
|
8637
8658
|
},
|
|
8638
8659
|
{
|
|
8639
8660
|
path: '/content-and-data/forms/overview',
|
|
@@ -11559,7 +11580,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
11559
11580
|
title: 'Your first API call',
|
|
11560
11581
|
heading: '',
|
|
11561
11582
|
anchor: '',
|
|
11562
|
-
text: 'Your first API call\nBy the end of this page you\'ll have made a real request to your own data and handled the errors properly. It assumes nothing — if you\'ve never used an API before, start at the top and follow along; if you have, skip to Step 3 and then read the API reference instead of the rest of this.\nEverything here uses curl, which is already installed on macOS and Linux and ships with Windows 10 and later. There\'s a JavaScript version of each step underneath.\nWhat you need\n- An organization on a plan that includes API access — Pro or Custom.\n- The Manage API keys permission, which owners and admins hold by default.\n- A terminal.'
|
|
11583
|
+
text: 'Your first API call\nBy the end of this page you\'ll have made a real request to your own data and handled the errors properly. It assumes nothing — if you\'ve never used an API before, start at the top and follow along; if you have, skip to Step 3 and then read the API reference instead of the rest of this.\nEverything here uses curl, which is already installed on macOS and Linux and ships with Windows 10 and later. There\'s a JavaScript version of each step underneath.\nWhat you need\n- An organization on a plan that includes API access — Starter, Pro or Custom.\n- The Manage API keys permission, which owners and admins hold by default.\n- A terminal.'
|
|
11563
11584
|
},
|
|
11564
11585
|
{
|
|
11565
11586
|
path: '/guides/your-first-api-call',
|
|
@@ -11601,7 +11622,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
11601
11622
|
title: 'Your first API call',
|
|
11602
11623
|
heading: 'The four errors you will hit',
|
|
11603
11624
|
anchor: '#the-four-errors-you-will-hit',
|
|
11604
|
-
text: 'Every error has the same shape, and type is the field to branch on:\n| You see | It means | Do this |\n| 401 unauthorized | Key missing, mistyped, or revoked. | Check the header is Authorization: Bearer aglynsk…. A common cause is a shell variable that didn\'t expand — echo $AGLYNAPIKEY. |\n| 403 insufficientscope | The key is fine; it lacks a permission. code names the exact scope. | Create a key with that scope. You can\'t add a scope to an existing key. |\n| 403 planrequired | The organization\'s plan doesn\'t include API access — or, on commerce endpoints, doesn\'t include commerce (code: "commerce"). | Not transient. Don\'t retry — alert a human. |\n| 429 ratelimited |
|
|
11625
|
+
text: 'Every error has the same shape, and type is the field to branch on:\n| You see | It means | Do this |\n| 401 unauthorized | Key missing, mistyped, or revoked. | Check the header is Authorization: Bearer aglynsk…. A common cause is a shell variable that didn\'t expand — echo $AGLYNAPIKEY. |\n| 403 insufficientscope | The key is fine; it lacks a permission. code names the exact scope. | Create a key with that scope. You can\'t add a scope to an existing key. |\n| 403 planrequired | The organization\'s plan doesn\'t include API access — or, on commerce endpoints, doesn\'t include commerce (code: "commerce"). | Not transient. Don\'t retry — alert a human. |\n| 429 ratelimited | A limit refused it — 120 requests/minute for this key, the workspace\'s per-minute limit across all its keys, or (on Starter) the monthly ceiling. code says which; see Rate limits. | Back off. Retry-After says for how long, and every response carries the remaining budget in its headers. |\nRetry 429 and 500. Never retry 401, 403, or 400 — nothing about them will change on the second attempt, and a loop that retries them turns a config mistake into a rate-limit ban.'
|
|
11605
11626
|
},
|
|
11606
11627
|
{
|
|
11607
11628
|
path: '/guides/your-first-api-call',
|
|
@@ -12686,7 +12707,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12686
12707
|
title: 'Add-ons',
|
|
12687
12708
|
heading: 'What you can add',
|
|
12688
12709
|
anchor: '#what-you-can-add',
|
|
12689
|
-
text: 'Buy extra capacity for the whole workspace on the Plan add-ons card under Billing → Plan: manager seats, datasets and extra sites apply straight away, while collaborator seats and POS registers become pools you then assign to a site.\nPrices live on one page Per-unit add-on prices are on aglyn.com/pricing, and what YOUR workspace would pay is shown in Billing before you confirm. This page covers what each add-on does and how it is billed; restating the numbers here would just be a second copy to keep in step.\n| Add-on | What it does | How it is priced |\n| Manager seats | Workspace manager seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Collaborator seats | Per-site collaborator (teammate) seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Extra datasets | Additional shared datasets across the workspace | Per dataset, per month |\n| Extra sites | Publish more sites than your plan includes | Per site, per month —
|
|
12710
|
+
text: 'Buy extra capacity for the whole workspace on the Plan add-ons card under Billing → Plan: manager seats, datasets and extra sites apply straight away, while collaborator seats and POS registers become pools you then assign to a site.\nPrices live on one page Per-unit add-on prices are on aglyn.com/pricing, and what YOUR workspace would pay is shown in Billing before you confirm. This page covers what each add-on does and how it is billed; restating the numbers here would just be a second copy to keep in step.\n| Add-on | What it does | How it is priced |\n| Manager seats | Workspace manager seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Collaborator seats | Per-site collaborator (teammate) seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Extra datasets | Additional shared datasets across the workspace | Per dataset, per month |\n| Extra sites | Publish more sites than your plan includes | Per site, per month — Starter\'s rate is higher than Pro\'s; aglyn.com/pricing has each |\n| POS registers | One extra point-of-sale register, assigned to one site | Flat per register, per month — the same on every plan |\n| Event Calendar | The event manager + calendar elements, workspace-wide | Flat per month — the same on every plan |\n| AI credits | Blocks of 5,000 AI credits a month added to your plan\'s own, workspace-wide, up to 30 blocks | Per block, per month — the same on every paid plan |\n| Site Care | Our team makes your small site changes for you, about an hour of work a month, workspace-wide | Flat per month — the same on every paid plan |\n- Prices are per unit per month. On annual billing, add-ons bill yearly alongside your plan (12× the monthly price) — a subscription has one billing interval.\n- POS registers also require a pl'
|
|
12690
12711
|
},
|
|
12691
12712
|
{
|
|
12692
12713
|
path: '/workspace-and-billing/billing-and-plans/add-ons',
|
|
@@ -12861,7 +12882,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12861
12882
|
title: 'Billing & Plans',
|
|
12862
12883
|
heading: 'Tiers & entitlements',
|
|
12863
12884
|
anchor: '#tiers--entitlements',
|
|
12864
|
-
text: 'Prices live on one page Current prices — monthly, annual, transaction fees and per-unit overage rates — are on aglyn.com/pricing, and your own plan and next invoice are in Billing in the console. This page explains how billing WORKS; it deliberately does not restate the numbers, because a second copy is a copy that goes stale.\n| Plan | What it is for |\n| Free | One site to build and publish — no selling, no custom domain |\n| Starter | One site with your own domain, a store, bookings and the
|
|
12885
|
+
text: 'Prices live on one page Current prices — monthly, annual, transaction fees and per-unit overage rates — are on aglyn.com/pricing, and your own plan and next invoice are in Billing in the console. This page explains how billing WORKS; it deliberately does not restate the numbers, because a second copy is a copy that goes stale.\n| Plan | What it is for |\n| Free | One site to build and publish — no selling, no custom domain |\n| Starter | One site with your own domain, a store, bookings, the CRM and the API, with the highest transaction fee |\n| Pro | The full platform: unlimited pages, products, forms, workflows and dataset records, POS, video, recurring billing, members-only content, gift cards, A/B testing, multilingual sites, scheduled publishing, the API and webhooks |\n| Custom | Everything in Pro, plus white-label, single sign-on, a dedicated support commitment, no transaction fee, and limits set by agreement |\nPro grows by add-ons, not by changing plan. It includes three sites and a set amount of storage, bandwidth, team seats, collaborators, datasets, CRM records, email, workflow runs, API requests and AI credits. Past any of them you buy more — an extra site, seat or dataset from Add-ons — or the extra usage is metered on your invoice. There is no ceiling on how many seats, collaborators or datasets a Pro workspace can add.\nTransaction fees are Aglyn platform fees on the sales you take through your site — storefront orders, recurring billing and paid bookings alike — separate from Stripe\'s payment-processing fees, which Stripe bills to your own Stripe account. Pro\'s are lower than Starter\'s, and Custom has none.\nEvery plan also includes an amount of monthly traffic — 2 GB on Free, more on each paid plan, and on Custom whatever the agreement sets. Passing it is meter'
|
|
12865
12886
|
},
|
|
12866
12887
|
{
|
|
12867
12888
|
path: '/workspace-and-billing/billing-and-plans/overview',
|
|
@@ -12903,7 +12924,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12903
12924
|
title: 'Billing & Plans',
|
|
12904
12925
|
heading: 'CRM records',
|
|
12905
12926
|
anchor: '#crm-records',
|
|
12906
|
-
text: 'Your CRM — the contacts captured from forms, member sign-ups, buyers and bookings, and the companies and deals your team files beside them — is priced as one CRM records band, not a hard cap. A record is a contact, a company or a deal; tasks, logged activities, pipelines and custom fields are not counted.\n- Each plan includes a band: Free 100, Starter 1,000 and Pro 10,000 records; on Custom the agreement sets it.\n- On Starter and Pro, growing past the band never blocks or drops anything — extra records are metered overage on your monthly invoice, at a per-1,000 rate that is lower on Pro — see pricing for the current rate on your plan, per extra 1,000 records per month.\n- On Free, which includes no CRM, the band is a hard limit on capture:
|
|
12927
|
+
text: 'Your CRM — the contacts captured from forms, member sign-ups, buyers and bookings, and the companies and deals your team files beside them — is priced as one CRM records band, not a hard cap. A record is a contact, a company or a deal; tasks, logged activities, pipelines and custom fields are not counted.\n- Each plan includes a band: Free 100, Starter 1,000 and Pro 10,000 records; on Custom the agreement sets it.\n- On Starter and Pro, growing past the band never blocks or drops anything — extra records are metered overage on your monthly invoice, at a per-1,000 rate that is lower on Pro — see pricing for the current rate on your plan, per extra 1,000 records per month.\n- On Free, which includes no CRM, the band is a hard limit on capture: your sites keep up to 100 people — contacts and the leads a form files, together — ready for the CRM when you upgrade. Past 100 a site adds no new person: the form entry is still saved under Forms and the visitor sees the normal confirmation, a new visitor keeps their member account and orders, and someone already kept is still updated, but no new contact or lead is made, and none is made later from the entries saved meanwhile. Everyone already kept stays. On Billing → Usage the band reads Stored records (organization), and at the limit it says new people are not being added, that form entries are still saved under Forms, and that upgrading keeps adding people; the owner is also told as the count nears and reaches 100. The Free plan card names no CRM records.\n- The billed count is the size of your CRM at the end of the month, not its size on any other day. The three collections are a running total rather than a monthly tally, so a month has to be charged on one moment in it, and that moment is the last daily reading taken before the mo'
|
|
12907
12928
|
},
|
|
12908
12929
|
{
|
|
12909
12930
|
path: '/workspace-and-billing/billing-and-plans/overview',
|
|
@@ -12917,7 +12938,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12917
12938
|
title: 'Billing & Plans',
|
|
12918
12939
|
heading: 'API access',
|
|
12919
12940
|
anchor: '#api-access',
|
|
12920
|
-
text: 'The customer REST API is included on Pro and Custom — mint scoped API keys and call the versioned /v1 endpoints from anywhere. Requests are metered per organization:\n|
|
|
12941
|
+
text: 'The customer REST API is included on Starter, Pro and Custom — mint scoped API keys and call the versioned /v1 endpoints from anywhere. Requests are metered per organization, and the plans differ in how much they allow:\n| | Starter | Pro | Custom |\n| Included requests / month | 500 | 1,500 | Set by your agreement |\n| Past the included requests | Metered per additional 1,000 | Metered per additional 1,000 | — |\n| Monthly ceiling | 20,000 requests, then refused until the month turns | None | Set by your agreement |\n| Requests per minute, whole workspace | 120 | 600 | Set by your agreement |\n| Requests per minute, per key | 120 | 120 | 120 |\n| Webhooks and Zapier hooks | Not included | Included | Included |\n- Requests past the included quota keep working and bill as metered overage on your monthly invoice. On Starter they stop at the monthly ceiling: the API answers 429 until the next calendar month (UTC). Pro has no ceiling.\n- The workspace limit counts every key together, so adding keys doesn\'t add capacity past it. See Rate limits & usage.\n- On any plan, a workspace that can\'t be billed for overage — no active subscription, or a 100% discount on the whole bill — stops at its included requests.\n- The billing page shows an API requests meter, and the usage-cap banner warns at 80% and 100% of the included quota.\n- Only requests that pass authentication and the rate limits are counted — rejected calls (bad key, wrong plan, rate-limited, past the ceiling) are never billed.\nConnected apps {#connected-apps}\nConnected apps lists every app that was connected to the workspace by signing in instead of with an API key, such as an AI assistant. To connect one, add Aglyn in the app, sign in when it asks, pick the workspace and choose View only or View and make changes. Each row shows'
|
|
12921
12942
|
},
|
|
12922
12943
|
{
|
|
12923
12944
|
path: '/workspace-and-billing/billing-and-plans/overview',
|