diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..ec446ba
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,66 @@
+name: CI
+
+on:
+ push:
+ pull_request:
+
+permissions:
+ contents: read
+
+jobs:
+ linux:
+ name: Linux (Swift ${{ matrix.swift }}, ${{ matrix.configuration }})
+ runs-on: ubuntu-24.04
+ container: swift:${{ matrix.swift }}-noble
+ timeout-minutes: 30
+ strategy:
+ fail-fast: false
+ matrix:
+ # The oldest supported Swift (swift-tools-version 6.2) and the newest.
+ swift: ["6.2", "6.4"]
+ configuration: [debug, release]
+ steps:
+ - uses: actions/checkout@v7
+
+ - name: Toolchain
+ run: swift --version
+
+ - name: Build (warnings are errors)
+ run: |
+ flags="-c ${{ matrix.configuration }} -Xswiftc -warnings-as-errors"
+ # @testable imports need testing enabled in an optimized build.
+ [ "${{ matrix.configuration }}" = release ] && flags="$flags -Xswiftc -enable-testing"
+ echo "FLAGS=$flags" >> "$GITHUB_ENV"
+ swift build --build-tests $flags
+
+ - name: Test
+ run: swift test $FLAGS
+
+ macos:
+ name: macOS (Xcode ${{ matrix.xcode }}, ${{ matrix.configuration }})
+ runs-on: macos-26
+ timeout-minutes: 30
+ strategy:
+ fail-fast: false
+ matrix:
+ # The oldest Xcode with Swift 6.2, and the runner's default.
+ xcode: ["26.0.1", "26.6"]
+ configuration: [debug, release]
+ steps:
+ - uses: actions/checkout@v7
+
+ - name: Select Xcode
+ run: |
+ sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app
+ swift --version
+
+ - name: Build (warnings are errors)
+ run: |
+ flags="-c ${{ matrix.configuration }} -Xswiftc -warnings-as-errors"
+ # @testable imports need testing enabled in an optimized build.
+ [ "${{ matrix.configuration }}" = release ] && flags="$flags -Xswiftc -enable-testing"
+ echo "FLAGS=$flags" >> "$GITHUB_ENV"
+ swift build --build-tests $flags
+
+ - name: Test
+ run: swift test $FLAGS
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8dada3e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/Package.swift b/Package.swift
index 1832417..cbdd9e3 100644
--- a/Package.swift
+++ b/Package.swift
@@ -3,7 +3,7 @@ import PackageDescription
let package = Package(
name: "PerfectFileMakerDataAPI",
- platforms: [.macOS(.v26)],
+ platforms: [.macOS(.v12)],
products: [
.library(name: "PerfectFileMakerDataAPI", targets: ["PerfectFileMakerDataAPI"]),
],
diff --git a/README.md b/README.md
index 0518a39..e163bfd 100644
--- a/README.md
+++ b/README.md
@@ -1,71 +1,50 @@
-# Perfect-FileMaker-DataAPI
-
-A modern, dependency-free Swift client for FileMaker's Data API — the REST/JSON
-web service (`/fmi/data/v1`) exposed by FileMaker Server. Built with Swift 6
-concurrency: every network call is `async throws`, the public entry point
-(`FileMakerServer`) is `Sendable`, and session/token state lives in an
-`FMPSession` actor rather than behind manual locking.
-
-## Status: staged for future integration
-
-This package is real, working code, not a stub. It is currently exercised
-only through **FMTestApp**, a standalone local test harness — it is **not
-yet wired into Perfect-Lasso's own `Package.swift`**. It is the planned
-successor/complement to the classic XML CWP client
-([`Perfect-FileMaker`](../Perfect-FileMaker)) that Perfect-Lasso uses today:
-that package speaks FileMaker's older XML Custom Web Publishing protocol,
-while this one speaks FileMaker's newer HTTP/JSON Data API. Integration into
-Perfect-Lasso is planned future work, not abandoned or superseded code.
+# Perfect FileMaker Data API
+
+
+ 
+ 
+
+ 
+
+
+
+A dependency-free Swift client for the FileMaker Data API, the REST/JSON web service
+(`/fmi/data/v1`) that FileMaker Server exposes. Every network call is `async throws`, the entry
+point (`FileMakerServer`) is `Sendable`, and the bearer token lives in an actor rather than behind
+manual locking.
+
+This is a new package, not a port. For FileMaker's older XML Custom Web Publishing protocol, use
+[Perfect-FileMaker](https://github.com/PerfectlySoft/Perfect-FileMaker); for FileMaker Server's
+Admin API, use [Perfect-FileMaker-AdminAPI](https://github.com/PerfectlySoft/Perfect-FileMaker-AdminAPI).
+The three packages are independent of each other.
## Requirements
-- Swift tools version **6.2**
-- **macOS 26** or later (the only platform declared in `Package.swift`; no
- iOS/watchOS/tvOS platform entries). Sources are also guarded with
- `#if canImport(FoundationNetworking)` for Linux source-compatibility, but
- Linux is not yet declared as a supported platform.
-- Zero external package dependencies — built entirely on `Foundation`
- (`FoundationNetworking` on Linux).
+- Swift 6.2 or later (`swift-tools-version: 6.2`, Swift 6 language mode).
+- macOS 12 or later, or Linux (`FoundationNetworking`). CI covers Swift 6.2 and 6.4 on Ubuntu
+ 24.04 and Xcode 26.0.1 and 26.6 on macOS, in debug and release, with warnings as errors.
+- No package dependencies.
-## Installation
-
-Add it as a local Swift Package Manager dependency:
+## Using in your project
```swift
-.package(path: "../Perfect-FileMaker-DataAPI")
+.package(url: "https://github.com/PerfectlySoft/Perfect-FileMaker-DataAPI.git", from: "1.0.0"),
```
-and add `"PerfectFileMakerDataAPI"` to your target's dependencies.
-
-## What it does
-
-`Sources/PerfectFileMakerDataAPI/` (6 files, ~700 lines):
-
-- **`FileMakerServer`** — the main `Sendable` entry point: database and
- layout listing, record CRUD (`getRecord`, `getRecords`, `createRecord`,
- `editRecord`, `deleteRecord`), compound find (`find(layout:query:)`),
- script execution (`executeScript`), and `logout()`.
-- **`FMPSession`** — an actor that lazily fetches and caches the bearer
- token, and automatically invalidates and re-authenticates on a 401/403.
-- **`FMPQuery`** / `FMPFindRequest` — builds compound find requests, sorts,
- and script parameters.
-- **`FMPRecord`** — the record model, including a generic
- `decode(_:)` helper for mapping a record's field data
- straight into your own `Decodable` types.
-- **`FMPLayoutInfo`** — field and portal metadata returned by layout
- introspection.
-- **`FMPError`** — a dedicated error type for Data API failures.
-
-It also has FileMaker-specific quirks already handled correctly: FileMaker's
-"no records match" (401) and "empty table" (101) response codes are turned
-into an empty result set instead of being thrown as errors, and FileMaker's
-nested layout-folder structure is flattened when listing layouts.
+```swift
+.product(name: "PerfectFileMakerDataAPI", package: "Perfect-FileMaker-DataAPI"),
+```
## Usage
```swift
import PerfectFileMakerDataAPI
+struct Contact: Decodable {
+ let name: String
+ let city: String
+}
+
let server = FileMakerServer(
host: "fm.example.com",
database: "Contacts",
@@ -75,27 +54,43 @@ let server = FileMakerServer(
let results = try await server.find(
layout: "ContactList",
- query: FMPQuery().adding(findRequest: FMPFindRequest(fields: ["City": "Denver"]))
+ query: FMPQuery().adding(findRequest: FMPFindRequest(fields: ["city": "Denver"]))
)
for record in results.records {
let contact = try record.decode(Contact.self)
- print(contact)
+ print(contact.name)
}
```
-The bearer token is fetched and cached automatically on first use — there is
-no separate login call to make.
+There is no separate login call. The token is fetched on first use, cached, and refreshed
+automatically after a 401 or 403.
-## Testing
+## What's here
-`Tests/PerfectFileMakerDataAPITests/` covers the client's request/response
-handling. Run with:
+- **`FileMakerServer`**: database and layout listing, layout metadata, record CRUD (`getRecord`,
+ `getRecords`, `createRecord`, `editRecord`, `deleteRecord`), compound find
+ (`find(layout:query:)`), script execution (`executeScript`), and `logout()`.
+- **`FMPQuery`**, **`FMPFindRequest`**, **`FMPSortField`**, **`FMPScripts`**: compound find
+ requests (including omit requests), sort order, paging, and pre-request, pre-sort and
+ after-find scripts.
+- **`FMPRecord`** and **`FMPResultSet`**: records with typed field values and portal rows, plus
+ `decode(_:)` to map a record's field data onto your own `Decodable` type.
+- **`FMPLayoutInfo`**: field and portal metadata from layout introspection.
+- **`FMPError`**: Data API failures.
-```
+Two FileMaker quirks are handled for you. A find that matches nothing (FileMaker error 401) and an
+empty table (error 101) come back as an empty result set instead of a thrown error. Layout
+listings flatten FileMaker's nested layout folders.
+
+## Testing
+
+```sh
swift test
```
+The tests cover request building and response decoding and don't need a FileMaker Server.
+
## License
-No LICENSE file is currently present in this repository.
+Apache 2.0. See [LICENSE](LICENSE).