Skip to content

Commit 07553e5

Browse files
jwfingjwfing
committed
docs: add Apache-2.0 LICENSE, README, CHANGELOG, CONTRIBUTING
1 parent bcfda3f commit 07553e5

4 files changed

Lines changed: 543 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Changelog
2+
3+
All notable changes to the InsForge Dart/Flutter SDK are documented here. This
4+
project follows [Semantic Versioning](https://semver.org) and
5+
[Keep a Changelog](https://keepachangelog.com).
6+
7+
## 0.1.0
8+
9+
Initial release.
10+
11+
### Added
12+
13+
- **`insforge` (pure Dart)** — the shared, framework-agnostic SDK:
14+
- `InsforgeHttpClient`: auth-header injection, single-flight 401 token
15+
refresh, typed `InsforgeException` error mapping.
16+
- **Auth**: email/password sign-up & sign-in, code-based email verification,
17+
PKCE OAuth (`getOAuthUrl` / `handleOAuthCallback`), sessions with proactive
18+
refresh, profiles, and a broadcast `onAuthStateChange` stream.
19+
- **Database**: PostgREST-style query builder — filters (including multiple
20+
AND-ed conditions per column), ordering, pagination, `single`/`count`,
21+
`insert`/`update`/`delete`/`upsert`, and RPC.
22+
- **Storage**: buckets and objects — multipart upload, download, list,
23+
delete, public URLs, the upload/download strategy flow, and presigned S3
24+
`uploadLarge`.
25+
- **Functions**: edge-function invocation across all HTTP verbs.
26+
- **AI**: standalone OpenRouter (OpenAI-compatible) client — chat
27+
completions with SSE streaming, embeddings, images, and model listing.
28+
- `SessionStorage` interface + `InMemorySessionStorage`.
29+
- `InsforgeClient` aggregator wiring every module onto one shared transport.
30+
- **`insforge_flutter`** — the Flutter integration layer:
31+
- `SecureSessionStorage` backed by `flutter_secure_storage`.
32+
- `Insforge.initialize(...)` / `Insforge.instance` singleton that restores a
33+
persisted session before the first frame.

‎CONTRIBUTING.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Contributing to the InsForge Dart/Flutter SDK
2+
3+
Thanks for helping improve the SDK! This guide covers the repository layout,
4+
local setup, testing, and the conventions we follow.
5+
6+
## Repository layout
7+
8+
This is a [Dart pub workspace](https://dart.dev/tools/pub/workspaces) (a
9+
monorepo resolved together):
10+
11+
```
12+
packages/
13+
insforge/ # pure-Dart SDK (auth, database, storage, functions, ai)
14+
insforge_flutter/ # Flutter layer: SecureSessionStorage + Insforge singleton
15+
integration_tests/ # live, against-a-real-project tests (opt-in via env vars)
16+
samples/
17+
twitter_app/ # full Flutter sample app
18+
```
19+
20+
`insforge_flutter` depends on and re-exports `insforge`.
21+
22+
## Prerequisites
23+
24+
- Flutter ≥ 3.24 (bundles a compatible Dart ≥ 3.5). `flutter --version` and
25+
`dart --version` must both work.
26+
- Because the workspace contains a Flutter package, resolve it with **`flutter
27+
pub get`** (not `dart pub get`) from the repo root.
28+
29+
```bash
30+
flutter pub get
31+
```
32+
33+
## Running the checks
34+
35+
Everything must pass before a change is merged.
36+
37+
```bash
38+
# Static analysis (whole workspace)
39+
dart analyze .
40+
41+
# Pure-Dart unit tests
42+
cd packages/insforge && dart test
43+
44+
# Flutter unit tests
45+
cd packages/insforge_flutter && flutter test
46+
```
47+
48+
Formatting must be clean:
49+
50+
```bash
51+
dart format .
52+
```
53+
54+
The analyzer config (`analysis_options.yaml`) enables stricter lints —
55+
notably `require_trailing_commas`, `prefer_single_quotes`, and
56+
`avoid_print`. CI runs `dart analyze .` plus every package's tests and fails
57+
on any issue.
58+
59+
## Integration tests (live backend)
60+
61+
`integration_tests/` exercises the SDK against a real InsForge project. With no
62+
environment variables set, **every test skips** — so it's safe in normal CI.
63+
To run it, provide a project and a pre-verified account:
64+
65+
```bash
66+
cd integration_tests
67+
INSFORGE_INTEGRATION_BASE_URL=https://<project>.insforge.app \
68+
INSFORGE_INTEGRATION_ANON_KEY=<anon-key> \
69+
INSFORGE_INTEGRATION_TEST_EMAIL=<verified-account-email> \
70+
INSFORGE_INTEGRATION_TEST_PASSWORD=<password> \
71+
INSFORGE_INTEGRATION_API_KEY=<project-api-key> \ # for storage
72+
INSFORGE_INTEGRATION_OPENROUTER_KEY=<openrouter-key> \ # for ai
73+
dart test
74+
```
75+
76+
See `integration_tests/README.md` for the required backend schema (the
77+
`sdk_test` table, a `public` bucket, and a `hello-world` function). Never
78+
commit real keys — keep them in your shell.
79+
80+
## Coding conventions
81+
82+
- **Models** use hand-written `fromJson`/`toJson` (no codegen). Be tolerant of
83+
missing/optional fields the backend may omit.
84+
- **Errors**: throw the typed `InsforgeException` hierarchy; don't return
85+
`{data, error}` tuples.
86+
- **No Flutter in `insforge`**: the `insforge` package must stay pure Dart so it
87+
runs under `dart test`. Anything needing Flutter belongs in
88+
`insforge_flutter`.
89+
- Keep the public API stable; document deviations from the backend contract.
90+
91+
## Commit messages
92+
93+
We use [Conventional Commits](https://www.conventionalcommits.org):
94+
95+
```
96+
feat(database): accumulate multiple filters per column
97+
fix(auth): tolerate signUp response without a user
98+
test(integration): cover the email verification flow
99+
docs(readme): document the AI module
100+
```
101+
102+
Scopes are typically a module name (`auth`, `database`, `storage`,
103+
`functions`, `ai`, `core`) or `sample` / `integration` / `ci`.
104+
105+
## Pull requests
106+
107+
1. Branch off `main`.
108+
2. Make the change with tests; keep `dart analyze .` and all suites green.
109+
3. If a change is driven by real backend behavior, add or update an integration
110+
test that proves it.
111+
4. Update `CHANGELOG.md` under the unreleased/next version.
112+
5. Open a PR describing the change and how you verified it.
113+
114+
By contributing, you agree that your contributions are licensed under the
115+
project's [Apache License 2.0](LICENSE).

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)