Skip to content

Commit 93f6390

Browse files
shirakabaJamie Birch
andauthored
Rename from ObjCBridge to NativeScript, and split into @nativescript/ios-node-api and @nativescript/macos-node-api (#25)
* chore: rename package from "objc" -> "@nativescript/ios-macos" * chore: relicense as MIT * chore: rename "ObjCBridge" -> "NativeScript" * chore: rename "charon" -> "nativescript_node_api_runtime" * Revert "chore: rename "charon" -> "nativescript_node_api_runtime"" This reverts commit 76e1c05cb62daac27cfd650e12f3bfcde9c81ffc. * chore: update package.json metadata * fix: resolution of typings * chore: add prepublishOnly script * chore: republish * rearrange repo as @nativescript/ios-napi, @nativescript/macos-napi * commit iOS Podspec (mainly for the benefit React Native) * rename as @nativescript/runtime-ios, @nativescript/runtime-macos * rename as @nativescript/ios-node-api, @nativescript/macos-node-api --------- Co-authored-by: Jamie Birch <[email protected]>
1 parent a60b594 commit 93f6390

File tree

153 files changed

+250972
-415
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

153 files changed

+250972
-415
lines changed

CMakeLists.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ cmake_minimum_required(VERSION 3.15)
33
set(BRIDGE_TARGET_PLATFORM "macos" CACHE STRING "Target platform for the Objective-C bridge")
44
set(METADATA_SIZE 0 CACHE STRING "Size of embedded metadata in bytes")
55

6-
project(ObjCBridge)
6+
project(NativeScript)
77

8-
set(NAME ObjCBridge)
8+
set(NAME NativeScript)
99
set(VERSION 0.1.0)
1010

1111
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fobjective-c")
@@ -117,7 +117,7 @@ set_target_properties(${NAME} PROPERTIES
117117
FRAMEWORK_VERSION ${VERSION}
118118
MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${VERSION}
119119
MACOSX_FRAMEWORK_BUNDLE_VERSION ${VERSION}
120-
MACOSX_FRAMEWORK_IDENTIFIER com.nativescript.ObjCBridge-${BRIDGE_TARGET_PLATFORM}
120+
MACOSX_FRAMEWORK_IDENTIFIER org.nativescript.nativescript-${BRIDGE_TARGET_PLATFORM}
121121
)
122122

123123
if (BUILD_FRAMEWORK)

LICENSE

Lines changed: 19 additions & 202 deletions
Original file line numberDiff line numberDiff line change
@@ -1,202 +1,19 @@
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 2023 DjDeveloperr
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.
1+
Copyright OpenJS Foundation and other contributors, https://openjsf.org
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in
11+
all copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1-
# Objective-C Bridge
1+
# NativeScript (Node-API)
22

3-
Objective-C bridge that allows accessing Objective-C APIs dynamically in
4-
JavaScript land. Made using Node-API and `libffi` under the hood.
3+
An embeddable, engine-agnostic NativeScript runtime based on [Node-API](https://nodejs.org/api/n-api.html) and [libffi](https://github.com/libffi/libffi).
4+
5+
This library allows any JavaScript engine or runtime that supports Node-API to access native APIs directly from JavaScript. At present, it supports accessing Objective-C APIs (thus most of the iOS and macOS SDKs). We hope to support other native APIs, such as the Java-based Android SDK, in future.
6+
7+
## Initializing repo
8+
9+
The repo makes use of npm [workspaces](https://docs.npmjs.com/cli/v10/using-npm/workspaces), so installation is straightforward.
10+
11+
```sh
12+
npm install
13+
14+
# This installs dependencies for all except `runtime/TestApp`, as that project
15+
# currently assumes that you have a git checkout of the NativeScript repo as a
16+
# sibling to this repo. Hopefully you have no need to use `runtime/TestApp, but
17+
# if you do, make sure you've set up the NativeScript repo as a sibling, and
18+
# perform another `npm install` inside `runtime/TestApp`.
19+
```
20+
21+
## Generating metadata
22+
23+
```sh
24+
deno task metagen ios
25+
deno task metagen macos
26+
```
527

628
## Building
729

@@ -32,13 +54,12 @@ node examples/spritekit.js
3254

3355
Deno Node-API has an issue with `napi_get_all_property_names`.
3456

35-
Without a custom deno build from the below PR, you can't use AppKit in Deno
36-
(works in Node).
57+
Without a custom Deno build from the below PR, you can't use AppKit in Deno (works in Node).
3758

3859
Upstream PR: https://github.com/denoland/deno/pull/19585
3960

4061
## License
4162

42-
Apache 2.0 licensed.
63+
MIT licensed.
4364

4465
Copyright © 2023 DjDeveloperr

bench/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import "objc";
1+
import "@nativescript/macos-node-api";
22
import { bench, run } from "mitata";
33

44
const arr = NSMutableArray.arrayWithCapacity(100);

bench/package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@
99
},
1010
"keywords": [],
1111
"author": "",
12-
"license": "ISC",
12+
"license": "MIT",
1313
"dependencies": {
14-
"mitata": "^0.1.6",
15-
"objc": "file:.."
14+
"mitata": "^0.1.6"
1615
}
1716
}

core-test/package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"keywords": [],
1010
"author": "",
11-
"license": "ISC",
11+
"license": "MIT",
1212
"devDependencies": {
1313
"@swc/cli": "^0.1.62",
1414
"@swc/core": "^1.3.95",
@@ -19,7 +19,6 @@
1919
"acorn": "^8.11.2",
2020
"css-tree": "^2.3.1",
2121
"emoji-regex": "^10.3.0",
22-
"objc": "file:..",
2322
"reduce-css-calc": "^2.1.8",
2423
"tslib": "^2.6.2"
2524
}

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@
4646
},
4747

4848
"imports": {
49-
"objc": "./mod.ts"
49+
"@nativescript/macos-node-api": "./packages/macos/mod.ts"
5050
}
5151
}

0 commit comments

Comments
 (0)