datasette-acl-share 0.0.1a2__tar.gz

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.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,180 @@
1
+ Metadata-Version: 2.4
2
+ Name: datasette-acl-share
3
+ Version: 0.0.1a2
4
+ Summary: Reusable Google-Docs-style share dialog for Datasette (<datasette-acl-share-dialog>)
5
+ Author: Alex Garcia
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/datasette/datasette-acl-share
8
+ Project-URL: Changelog, https://github.com/datasette/datasette-acl-share/releases
9
+ Project-URL: Issues, https://github.com/datasette/datasette-acl-share/issues
10
+ Classifier: Framework :: Datasette
11
+ Requires-Python: >=3.10
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: datasette>=1.0a30
15
+ Requires-Dist: datasette-vite>=0.0.1a4
16
+ Requires-Dist: datasette-acl>=0.5a1
17
+ Dynamic: license-file
18
+
19
+ # datasette-acl-share
20
+
21
+ A reusable, Google-Docs-style **share dialog** for Datasette, shipped as a
22
+ framework-agnostic Svelte 5 custom element: `<datasette-acl-share-dialog>`.
23
+
24
+ One component, embedded by every document plugin (paper, places, sheets, …). It
25
+ is the UI layer over the [datasette-acl](https://github.com/datasette/datasette-acl)
26
+ JSON API — grants, roles, groups, and "general access" wildcards. If
27
+ datasette-user-profiles is installed the dialog adds people search and avatars;
28
+ without it, it degrades gracefully to initials chips with no People search.
29
+
30
+ ## Usage
31
+
32
+ Drop the tag anywhere — inside a Svelte/Preact app, or in plain server-rendered
33
+ HTML (custom elements are just DOM):
34
+
35
+ ```html
36
+ <datasette-acl-share-dialog
37
+ resource-type="paper-doc"
38
+ parent="mydb"
39
+ child="42"
40
+ resource-label="Q2 Planning"
41
+ ></datasette-acl-share-dialog>
42
+ ```
43
+
44
+ The element renders a compact **share-icon button**; clicking it opens a modal
45
+ `<dialog>` (dismiss with the × button, the backdrop, or `Esc`). The resource is
46
+ fetched lazily on first open, so a page can carry many share buttons cheaply.
47
+
48
+ Once open, the dialog shows "people with access" (avatars, role dropdowns,
49
+ remove buttons), a "General access" section, and an add-box that searches
50
+ people (profiles) and groups (acl). Each action is its own fetch — grant /
51
+ update / revoke — matching Google Docs' incremental behaviour. Actors who
52
+ cannot manage the resource (`can_manage: false`) get a read-only roster: roles
53
+ as tags, no add-box, no remove buttons.
54
+
55
+ ### Attributes
56
+
57
+ | Attribute | Req | Purpose |
58
+ |---|---|---|
59
+ | `resource-type` | yes | acl resource type, e.g. `paper-doc`, `places-list`, `sheets-workbook` |
60
+ | `parent` | yes | resource identity part 1 (e.g. database name) |
61
+ | `child` | – | resource identity part 2 (e.g. row id); omit for parent-only resources |
62
+ | `resource-label` | – | display title shown in the dialog header |
63
+ | `actor-json` | – | current actor as JSON (`{"id":"alice","kind":"user"}`) — used to mark "(you)" |
64
+ | `features` | – | comma list of sections to show (`people,groups,public`); empty/missing = all available |
65
+ | `api-base` | – | override the acl API prefix (default `/-/acl/api`) |
66
+ | `open` | – | when set (any value other than `false`), open the modal on mount instead of waiting for a trigger click |
67
+ | `trigger-label` | – | text shown next to the share icon on the trigger button (icon-only if omitted) |
68
+ | `disabled` | – | when set (any value other than `false`), disable the trigger so the dialog can't open (e.g. the actor can't share this resource) |
69
+
70
+ ### Events
71
+
72
+ The element dispatches bubbling, composed `CustomEvent`s so hosts can react
73
+ (e.g. paper re-running its SSE subscriber sweep after a revoke):
74
+
75
+ | Event | `detail` |
76
+ |---|---|
77
+ | `share-granted` | `{principal, id, role}` |
78
+ | `share-updated` | `{principal, id, role}` |
79
+ | `share-revoked` | `{principal, id}` |
80
+ | `share-changed` | `{}` — fired after any mutation (coarse) |
81
+
82
+ `principal` is `"actor"` or `"group"`; `id` is the actor id, group id, or a
83
+ general-access wildcard (`*` / `_signed_in`).
84
+
85
+ ## Including the bundle (opt-in)
86
+
87
+ The bundle is built with and served via
88
+ [datasette-vite](https://github.com/datasette/datasette-vite). It is **not**
89
+ injected site-wide — a host plugin opts in from its own asset hooks so the
90
+ dialog only loads on pages that use it:
91
+
92
+ ```python
93
+ from datasette import hookimpl
94
+ from datasette_acl_share import datasette_share_assets
95
+
96
+ @hookimpl
97
+ def extra_js_urls(datasette, request):
98
+ # gate on your own page(s) so it doesn't load everywhere
99
+ if not _is_my_page(request):
100
+ return []
101
+ return datasette_share_assets(datasette)["js"]
102
+
103
+ @hookimpl
104
+ def extra_css_urls(datasette, request):
105
+ if not _is_my_page(request):
106
+ return []
107
+ return datasette_share_assets(datasette)["css"]
108
+ ```
109
+
110
+ The helper returns `{"js": [{"url": …, "module": True}], "css": [url, …]}`,
111
+ ready for Datasette's `extra_js_urls` / `extra_css_urls` hooks. In
112
+ datasette-vite dev mode the `js` list includes the Vite client (HMR) and `css`
113
+ is empty — your plugin code is identical in dev and prod. Hosts that own their
114
+ own Vite build can instead splice the URLs into their page template.
115
+
116
+ ## Capability probe
117
+
118
+ So a host can set `features` without guessing which optional backends exist:
119
+
120
+ ```
121
+ GET /-/share/capabilities → {"people": true, "groups": true, "public": true}
122
+ ```
123
+
124
+ `people` reflects whether
125
+ [datasette-user-profiles](https://github.com/datasette/datasette-user-profiles)
126
+ is installed (search + avatars); `groups` and `public` are intrinsic to
127
+ datasette-acl. `share_capabilities()` is also importable if you prefer to
128
+ compute the `features` string server-side.
129
+
130
+ ## Embedding in apps
131
+
132
+ A Svelte app (paper, places, sheets) renders the tag directly — attributes
133
+ bind, and `onshare-*` props receive the events:
134
+
135
+ ```svelte
136
+ <datasette-acl-share-dialog
137
+ resource-type="paper-doc"
138
+ parent={dbName}
139
+ child={docId}
140
+ resource-label={docTitle}
141
+ actor-json={JSON.stringify(actor)}
142
+ onshare-revoked={onShareRevoked}
143
+ ></datasette-acl-share-dialog>
144
+ ```
145
+
146
+ Preact hosts (datasette-comments) and plain Jinja pages embed the same tag
147
+ unchanged, wiring events with `addEventListener`.
148
+
149
+ > For a full walkthrough — modelling the acl resource type / actions / roles,
150
+ > seeding grants, gating pages, plus web-component tips and a minimal end-to-end
151
+ > plugin — see [`docs/integration-guide.md`](docs/integration-guide.md).
152
+
153
+ ## Development
154
+
155
+ ```sh
156
+ just frontend-install # one-time npm install
157
+ just frontend # production build (writes static/gen + manifest.json)
158
+ just dev # datasette + the sample-docs demo at :5171
159
+
160
+ # Or with Vite HMR:
161
+ just frontend-dev # terminal 1: vite dev server (port 5180)
162
+ just dev-with-hmr # terminal 2: datasette pointed at the dev server
163
+ ```
164
+
165
+ `just dev` loads a throwaway demo plugin (`tests/sample_plugins`, with templates
166
+ in `tests/templates`) plus datasette-debug-gotham / datasette-user-profiles /
167
+ datasette-debug-bar. Visit <http://localhost:5171/sample-docs>, switch
168
+ characters with the debug bar (Clark owns doc 1), and exercise the dialog — see
169
+ `CLAUDE.md` for the full demo walkthrough.
170
+
171
+ Built assets (`datasette_acl_share/static/`, `manifest.json`) are gitignored and
172
+ produced by the build.
173
+
174
+ ### Tests
175
+
176
+ ```sh
177
+ npm --prefix frontend run test # vitest (node + browser suites)
178
+ npm --prefix frontend run check # svelte-check + tsc
179
+ uv run pytest # Python: asset helper + capability probe
180
+ ```
@@ -0,0 +1,162 @@
1
+ # datasette-acl-share
2
+
3
+ A reusable, Google-Docs-style **share dialog** for Datasette, shipped as a
4
+ framework-agnostic Svelte 5 custom element: `<datasette-acl-share-dialog>`.
5
+
6
+ One component, embedded by every document plugin (paper, places, sheets, …). It
7
+ is the UI layer over the [datasette-acl](https://github.com/datasette/datasette-acl)
8
+ JSON API — grants, roles, groups, and "general access" wildcards. If
9
+ datasette-user-profiles is installed the dialog adds people search and avatars;
10
+ without it, it degrades gracefully to initials chips with no People search.
11
+
12
+ ## Usage
13
+
14
+ Drop the tag anywhere — inside a Svelte/Preact app, or in plain server-rendered
15
+ HTML (custom elements are just DOM):
16
+
17
+ ```html
18
+ <datasette-acl-share-dialog
19
+ resource-type="paper-doc"
20
+ parent="mydb"
21
+ child="42"
22
+ resource-label="Q2 Planning"
23
+ ></datasette-acl-share-dialog>
24
+ ```
25
+
26
+ The element renders a compact **share-icon button**; clicking it opens a modal
27
+ `<dialog>` (dismiss with the × button, the backdrop, or `Esc`). The resource is
28
+ fetched lazily on first open, so a page can carry many share buttons cheaply.
29
+
30
+ Once open, the dialog shows "people with access" (avatars, role dropdowns,
31
+ remove buttons), a "General access" section, and an add-box that searches
32
+ people (profiles) and groups (acl). Each action is its own fetch — grant /
33
+ update / revoke — matching Google Docs' incremental behaviour. Actors who
34
+ cannot manage the resource (`can_manage: false`) get a read-only roster: roles
35
+ as tags, no add-box, no remove buttons.
36
+
37
+ ### Attributes
38
+
39
+ | Attribute | Req | Purpose |
40
+ |---|---|---|
41
+ | `resource-type` | yes | acl resource type, e.g. `paper-doc`, `places-list`, `sheets-workbook` |
42
+ | `parent` | yes | resource identity part 1 (e.g. database name) |
43
+ | `child` | – | resource identity part 2 (e.g. row id); omit for parent-only resources |
44
+ | `resource-label` | – | display title shown in the dialog header |
45
+ | `actor-json` | – | current actor as JSON (`{"id":"alice","kind":"user"}`) — used to mark "(you)" |
46
+ | `features` | – | comma list of sections to show (`people,groups,public`); empty/missing = all available |
47
+ | `api-base` | – | override the acl API prefix (default `/-/acl/api`) |
48
+ | `open` | – | when set (any value other than `false`), open the modal on mount instead of waiting for a trigger click |
49
+ | `trigger-label` | – | text shown next to the share icon on the trigger button (icon-only if omitted) |
50
+ | `disabled` | – | when set (any value other than `false`), disable the trigger so the dialog can't open (e.g. the actor can't share this resource) |
51
+
52
+ ### Events
53
+
54
+ The element dispatches bubbling, composed `CustomEvent`s so hosts can react
55
+ (e.g. paper re-running its SSE subscriber sweep after a revoke):
56
+
57
+ | Event | `detail` |
58
+ |---|---|
59
+ | `share-granted` | `{principal, id, role}` |
60
+ | `share-updated` | `{principal, id, role}` |
61
+ | `share-revoked` | `{principal, id}` |
62
+ | `share-changed` | `{}` — fired after any mutation (coarse) |
63
+
64
+ `principal` is `"actor"` or `"group"`; `id` is the actor id, group id, or a
65
+ general-access wildcard (`*` / `_signed_in`).
66
+
67
+ ## Including the bundle (opt-in)
68
+
69
+ The bundle is built with and served via
70
+ [datasette-vite](https://github.com/datasette/datasette-vite). It is **not**
71
+ injected site-wide — a host plugin opts in from its own asset hooks so the
72
+ dialog only loads on pages that use it:
73
+
74
+ ```python
75
+ from datasette import hookimpl
76
+ from datasette_acl_share import datasette_share_assets
77
+
78
+ @hookimpl
79
+ def extra_js_urls(datasette, request):
80
+ # gate on your own page(s) so it doesn't load everywhere
81
+ if not _is_my_page(request):
82
+ return []
83
+ return datasette_share_assets(datasette)["js"]
84
+
85
+ @hookimpl
86
+ def extra_css_urls(datasette, request):
87
+ if not _is_my_page(request):
88
+ return []
89
+ return datasette_share_assets(datasette)["css"]
90
+ ```
91
+
92
+ The helper returns `{"js": [{"url": …, "module": True}], "css": [url, …]}`,
93
+ ready for Datasette's `extra_js_urls` / `extra_css_urls` hooks. In
94
+ datasette-vite dev mode the `js` list includes the Vite client (HMR) and `css`
95
+ is empty — your plugin code is identical in dev and prod. Hosts that own their
96
+ own Vite build can instead splice the URLs into their page template.
97
+
98
+ ## Capability probe
99
+
100
+ So a host can set `features` without guessing which optional backends exist:
101
+
102
+ ```
103
+ GET /-/share/capabilities → {"people": true, "groups": true, "public": true}
104
+ ```
105
+
106
+ `people` reflects whether
107
+ [datasette-user-profiles](https://github.com/datasette/datasette-user-profiles)
108
+ is installed (search + avatars); `groups` and `public` are intrinsic to
109
+ datasette-acl. `share_capabilities()` is also importable if you prefer to
110
+ compute the `features` string server-side.
111
+
112
+ ## Embedding in apps
113
+
114
+ A Svelte app (paper, places, sheets) renders the tag directly — attributes
115
+ bind, and `onshare-*` props receive the events:
116
+
117
+ ```svelte
118
+ <datasette-acl-share-dialog
119
+ resource-type="paper-doc"
120
+ parent={dbName}
121
+ child={docId}
122
+ resource-label={docTitle}
123
+ actor-json={JSON.stringify(actor)}
124
+ onshare-revoked={onShareRevoked}
125
+ ></datasette-acl-share-dialog>
126
+ ```
127
+
128
+ Preact hosts (datasette-comments) and plain Jinja pages embed the same tag
129
+ unchanged, wiring events with `addEventListener`.
130
+
131
+ > For a full walkthrough — modelling the acl resource type / actions / roles,
132
+ > seeding grants, gating pages, plus web-component tips and a minimal end-to-end
133
+ > plugin — see [`docs/integration-guide.md`](docs/integration-guide.md).
134
+
135
+ ## Development
136
+
137
+ ```sh
138
+ just frontend-install # one-time npm install
139
+ just frontend # production build (writes static/gen + manifest.json)
140
+ just dev # datasette + the sample-docs demo at :5171
141
+
142
+ # Or with Vite HMR:
143
+ just frontend-dev # terminal 1: vite dev server (port 5180)
144
+ just dev-with-hmr # terminal 2: datasette pointed at the dev server
145
+ ```
146
+
147
+ `just dev` loads a throwaway demo plugin (`tests/sample_plugins`, with templates
148
+ in `tests/templates`) plus datasette-debug-gotham / datasette-user-profiles /
149
+ datasette-debug-bar. Visit <http://localhost:5171/sample-docs>, switch
150
+ characters with the debug bar (Clark owns doc 1), and exercise the dialog — see
151
+ `CLAUDE.md` for the full demo walkthrough.
152
+
153
+ Built assets (`datasette_acl_share/static/`, `manifest.json`) are gitignored and
154
+ produced by the build.
155
+
156
+ ### Tests
157
+
158
+ ```sh
159
+ npm --prefix frontend run test # vitest (node + browser suites)
160
+ npm --prefix frontend run check # svelte-check + tsc
161
+ uv run pytest # Python: asset helper + capability probe
162
+ ```
@@ -0,0 +1,71 @@
1
+ """Python side of the ``<datasette-acl-share-dialog>`` share dialog.
2
+
3
+ Ships :func:`datasette_share_assets` (opt-in asset helper for hosts) and the
4
+ ``GET /-/share/capabilities`` probe. See the README for embedding details.
5
+ """
6
+
7
+ from datasette import hookimpl, Response
8
+ from datasette_vite import vite_js_urls, vite_css_urls
9
+
10
+ # Vite manifest key for the bundle entrypoint; importing the bundle registers
11
+ # the custom element.
12
+ ENTRYPOINT = "src/main.ts"
13
+ PLUGIN_PACKAGE = "datasette_acl_share"
14
+
15
+ # Optional backend that lights up People search + avatars.
16
+ PROFILES_PLUGIN = "datasette-user-profiles"
17
+
18
+
19
+ def datasette_share_assets(datasette):
20
+ """Return ``{"js": [...], "css": [...]}`` for the built bundle.
21
+
22
+ Hosts return these from their own ``extra_js_urls`` / ``extra_css_urls``
23
+ hooks (gated on their pages) so the dialog loads only where used — the
24
+ plugin deliberately registers no site-wide assets. In datasette-vite dev
25
+ mode the URLs point at the dev server and ``css`` is empty (Vite injects
26
+ CSS via JS).
27
+ """
28
+ return {
29
+ "js": vite_js_urls(
30
+ datasette=datasette,
31
+ entrypoint=ENTRYPOINT,
32
+ plugin_package=PLUGIN_PACKAGE,
33
+ ),
34
+ "css": vite_css_urls(
35
+ datasette=datasette,
36
+ entrypoint=ENTRYPOINT,
37
+ plugin_package=PLUGIN_PACKAGE,
38
+ ),
39
+ }
40
+
41
+
42
+ def share_capabilities():
43
+ """Report which dialog sections the installed backends can support.
44
+
45
+ ``people`` requires datasette-user-profiles; ``groups`` and ``public`` are
46
+ intrinsic to datasette-acl. Never raises — a missing plugin just yields
47
+ ``false``.
48
+ """
49
+ try:
50
+ from datasette.plugins import get_plugins
51
+
52
+ installed = {p.get("name") for p in get_plugins()}
53
+ except Exception:
54
+ installed = set()
55
+ return {
56
+ "people": PROFILES_PLUGIN in installed,
57
+ "groups": True,
58
+ "public": True,
59
+ }
60
+
61
+
62
+ async def capabilities_view():
63
+ """GET /-/share/capabilities → the capability probe as JSON (read-only)."""
64
+ return Response.json(share_capabilities())
65
+
66
+
67
+ @hookimpl
68
+ def register_routes():
69
+ return [
70
+ ("^/-/share/capabilities$", capabilities_view),
71
+ ]
@@ -0,0 +1,8 @@
1
+ {
2
+ "src/main.ts": {
3
+ "file": "static/gen/main-CnabIi8c.js",
4
+ "name": "main",
5
+ "src": "src/main.ts",
6
+ "isEntry": true
7
+ }
8
+ }